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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
|
// Generated by dts-bundle-generator v9.5.1
/** @category Version */
/** A string containing the version of the GraphQL.js library */
export declare const version: string;
/** An object containing the components of the GraphQL.js version string */
export declare const versionInfo: Readonly<{
major: number;
minor: number;
patch: number;
preReleaseTag: string | null;
}>;
/** @category Development Mode */
/**
* Enables GraphQL.js development mode checks for this module instance.
*
* Production entry points leave development mode disabled by default. Call this
* before constructing schemas or executing requests when additional development
* diagnostics should run.
* @example
* ```ts
* import { enableDevMode, isDevModeEnabled } from 'graphql/devMode';
*
* isDevModeEnabled(); // => false
* enableDevMode();
* isDevModeEnabled(); // => true
* ```
*/
export declare function enableDevMode(): void;
/**
* Returns whether GraphQL.js development mode has been enabled for this module
* instance.
* @returns True when development mode is enabled.
* @example
* ```ts
* import { enableDevMode, isDevModeEnabled } from 'graphql/devMode';
*
* enableDevMode();
*
* isDevModeEnabled(); // => true
* ```
*/
export declare function isDevModeEnabled(): boolean;
type Maybe<T> = null | undefined | T;
interface ObjMap<T> {
[key: string]: T;
}
interface ReadOnlyObjMap<T> {
readonly [key: string]: T;
}
declare const NAME = "Name";
type NAME = typeof NAME;
declare const DOCUMENT = "Document";
type DOCUMENT = typeof DOCUMENT;
declare const OPERATION_DEFINITION = "OperationDefinition";
type OPERATION_DEFINITION = typeof OPERATION_DEFINITION;
declare const VARIABLE_DEFINITION = "VariableDefinition";
type VARIABLE_DEFINITION = typeof VARIABLE_DEFINITION;
declare const SELECTION_SET = "SelectionSet";
type SELECTION_SET = typeof SELECTION_SET;
declare const FIELD = "Field";
type FIELD = typeof FIELD;
declare const ARGUMENT = "Argument";
type ARGUMENT = typeof ARGUMENT;
declare const FRAGMENT_ARGUMENT = "FragmentArgument";
type FRAGMENT_ARGUMENT = typeof FRAGMENT_ARGUMENT;
declare const FRAGMENT_SPREAD = "FragmentSpread";
type FRAGMENT_SPREAD = typeof FRAGMENT_SPREAD;
declare const INLINE_FRAGMENT = "InlineFragment";
type INLINE_FRAGMENT = typeof INLINE_FRAGMENT;
declare const FRAGMENT_DEFINITION = "FragmentDefinition";
type FRAGMENT_DEFINITION = typeof FRAGMENT_DEFINITION;
declare const VARIABLE = "Variable";
type VARIABLE = typeof VARIABLE;
declare const INT = "IntValue";
type INT = typeof INT;
declare const FLOAT = "FloatValue";
type FLOAT = typeof FLOAT;
declare const STRING = "StringValue";
type STRING = typeof STRING;
declare const BOOLEAN = "BooleanValue";
type BOOLEAN = typeof BOOLEAN;
declare const NULL = "NullValue";
type NULL = typeof NULL;
declare const ENUM = "EnumValue";
type ENUM = typeof ENUM;
declare const LIST = "ListValue";
type LIST = typeof LIST;
declare const OBJECT = "ObjectValue";
type OBJECT = typeof OBJECT;
declare const OBJECT_FIELD = "ObjectField";
type OBJECT_FIELD = typeof OBJECT_FIELD;
declare const DIRECTIVE = "Directive";
type DIRECTIVE = typeof DIRECTIVE;
declare const NAMED_TYPE = "NamedType";
type NAMED_TYPE = typeof NAMED_TYPE;
declare const LIST_TYPE = "ListType";
type LIST_TYPE = typeof LIST_TYPE;
declare const NON_NULL_TYPE = "NonNullType";
type NON_NULL_TYPE = typeof NON_NULL_TYPE;
declare const SCHEMA_DEFINITION = "SchemaDefinition";
type SCHEMA_DEFINITION = typeof SCHEMA_DEFINITION;
declare const OPERATION_TYPE_DEFINITION = "OperationTypeDefinition";
type OPERATION_TYPE_DEFINITION = typeof OPERATION_TYPE_DEFINITION;
declare const SCALAR_TYPE_DEFINITION = "ScalarTypeDefinition";
type SCALAR_TYPE_DEFINITION = typeof SCALAR_TYPE_DEFINITION;
declare const OBJECT_TYPE_DEFINITION = "ObjectTypeDefinition";
type OBJECT_TYPE_DEFINITION = typeof OBJECT_TYPE_DEFINITION;
declare const FIELD_DEFINITION = "FieldDefinition";
type FIELD_DEFINITION = typeof FIELD_DEFINITION;
declare const INPUT_VALUE_DEFINITION = "InputValueDefinition";
type INPUT_VALUE_DEFINITION = typeof INPUT_VALUE_DEFINITION;
declare const INTERFACE_TYPE_DEFINITION = "InterfaceTypeDefinition";
type INTERFACE_TYPE_DEFINITION = typeof INTERFACE_TYPE_DEFINITION;
declare const UNION_TYPE_DEFINITION = "UnionTypeDefinition";
type UNION_TYPE_DEFINITION = typeof UNION_TYPE_DEFINITION;
declare const ENUM_TYPE_DEFINITION = "EnumTypeDefinition";
declare const ENUM_VALUE_DEFINITION = "EnumValueDefinition";
type ENUM_VALUE_DEFINITION = typeof ENUM_VALUE_DEFINITION;
declare const INPUT_OBJECT_TYPE_DEFINITION = "InputObjectTypeDefinition";
type INPUT_OBJECT_TYPE_DEFINITION = typeof INPUT_OBJECT_TYPE_DEFINITION;
declare const DIRECTIVE_DEFINITION = "DirectiveDefinition";
type DIRECTIVE_DEFINITION = typeof DIRECTIVE_DEFINITION;
declare const SCHEMA_EXTENSION = "SchemaExtension";
type SCHEMA_EXTENSION = typeof SCHEMA_EXTENSION;
declare const DIRECTIVE_EXTENSION = "DirectiveExtension";
type DIRECTIVE_EXTENSION = typeof DIRECTIVE_EXTENSION;
declare const SCALAR_TYPE_EXTENSION = "ScalarTypeExtension";
type SCALAR_TYPE_EXTENSION = typeof SCALAR_TYPE_EXTENSION;
declare const OBJECT_TYPE_EXTENSION = "ObjectTypeExtension";
type OBJECT_TYPE_EXTENSION = typeof OBJECT_TYPE_EXTENSION;
declare const INTERFACE_TYPE_EXTENSION = "InterfaceTypeExtension";
type INTERFACE_TYPE_EXTENSION = typeof INTERFACE_TYPE_EXTENSION;
declare const UNION_TYPE_EXTENSION = "UnionTypeExtension";
type UNION_TYPE_EXTENSION = typeof UNION_TYPE_EXTENSION;
declare const ENUM_TYPE_EXTENSION = "EnumTypeExtension";
type ENUM_TYPE_EXTENSION = typeof ENUM_TYPE_EXTENSION;
declare const INPUT_OBJECT_TYPE_EXTENSION = "InputObjectTypeExtension";
type INPUT_OBJECT_TYPE_EXTENSION = typeof INPUT_OBJECT_TYPE_EXTENSION;
declare const TYPE_COORDINATE = "TypeCoordinate";
type TYPE_COORDINATE = typeof TYPE_COORDINATE;
declare const MEMBER_COORDINATE = "MemberCoordinate";
type MEMBER_COORDINATE = typeof MEMBER_COORDINATE;
declare const ARGUMENT_COORDINATE = "ArgumentCoordinate";
type ARGUMENT_COORDINATE = typeof ARGUMENT_COORDINATE;
declare const DIRECTIVE_COORDINATE = "DirectiveCoordinate";
type DIRECTIVE_COORDINATE = typeof DIRECTIVE_COORDINATE;
declare const DIRECTIVE_ARGUMENT_COORDINATE = "DirectiveArgumentCoordinate";
type DIRECTIVE_ARGUMENT_COORDINATE = typeof DIRECTIVE_ARGUMENT_COORDINATE;
type KindTypeMap = typeof Kind;
interface Location {
line: number;
column: number;
}
/**
* A representation of source input to GraphQL. The `name` and `locationOffset` parameters are
* optional, but they are useful for clients who store GraphQL documents in source files.
* For example, if the GraphQL input starts at line 40 in a file named `Foo.graphql`, it might
* be useful for `name` to be `"Foo.graphql"` and location to be `{ line: 40, column: 1 }`.
* The `line` and `column` properties in `locationOffset` are 1-indexed.
*/
export declare class Source {
/** The GraphQL source text. */
body: string;
/** Name used in diagnostics for this source, such as a file path or request name. */
name: string;
/** One-indexed line and column where this source begins. */
locationOffset: Location;
/**
* Creates a Source instance.
* @param body - The GraphQL source text.
* @param name - Name used in diagnostics for this source.
* @param locationOffset - One-indexed line and column where this source begins.
* @example
* ```ts
* import { Source } from 'graphql/language';
*
* const source = new Source('type Query { greeting: String }', 'schema.graphql', {
* line: 10,
* column: 1,
* });
*
* source.body; // => 'type Query { greeting: String }'
* source.name; // => 'schema.graphql'
* source.locationOffset; // => { line: 10, column: 1 }
* ```
*/
constructor(body: string, name?: string, locationOffset?: Location);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
}
/** @category Lexing */
/**
* An exported enum describing the different kinds of tokens that the
* lexer emits.
*/
export declare const TokenKind: {
readonly SOF: "<SOF>";
readonly EOF: "<EOF>";
readonly BANG: "!";
readonly DOLLAR: "$";
readonly AMP: "&";
readonly PAREN_L: "(";
readonly PAREN_R: ")";
readonly DOT: ".";
readonly SPREAD: "...";
readonly COLON: ":";
readonly EQUALS: "=";
readonly AT: "@";
readonly BRACKET_L: "[";
readonly BRACKET_R: "]";
readonly BRACE_L: "{";
readonly PIPE: "|";
readonly BRACE_R: "}";
readonly NAME: "Name";
readonly INT: "Int";
readonly FLOAT: "Float";
readonly STRING: "String";
readonly BLOCK_STRING: "BlockString";
readonly COMMENT: "Comment";
};
/**
* An exported enum describing the different kinds of tokens that the
* lexer emits.
*/
export type TokenKind = (typeof TokenKind)[keyof typeof TokenKind];
/**
* Contains a range of UTF-8 character offsets and token references that
* identify the region of the source from which the AST derived.
*/
declare class Location$1 {
/** The character offset at which this Node begins. */
readonly start: number;
/** The character offset at which this Node ends. */
readonly end: number;
/** The Token at which this Node begins. */
readonly startToken: Token;
/** The Token at which this Node ends. */
readonly endToken: Token;
/** The Source document the AST represents. */
readonly source: Source;
/**
* Creates a Location instance.
* @param startToken - The start token.
* @param endToken - The end token.
* @param source - Source document used to derive error locations.
* @example
* ```ts
* import { Location, Source, Token, TokenKind } from 'graphql/language';
*
* const source = new Source('{ hello }');
* const startToken = new Token(TokenKind.BRACE_L, 0, 1, 1, 1);
* const endToken = new Token(TokenKind.BRACE_R, 8, 9, 1, 9);
* const location = new Location(startToken, endToken, source);
*
* location.start; // => 0
* location.end; // => 9
* location.source.body; // => '{ hello }'
* ```
*/
constructor(startToken: Token, endToken: Token, source: Source);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a JSON representation of this location.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { parse } from 'graphql/language';
*
* const document = parse('{ hello }');
* const location = document.loc?.toJSON();
*
* location; // => { start: 0, end: 9 }
* ```
*/
toJSON(): {
start: number;
end: number;
};
}
/**
* Represents a range of characters represented by a lexical token
* within a Source.
*/
export declare class Token {
/** The kind of Token. */
readonly kind: TokenKind;
/** The character offset at which this Node begins. */
readonly start: number;
/** The character offset at which this Node ends. */
readonly end: number;
/** The 1-indexed line number on which this Token appears. */
readonly line: number;
/** The 1-indexed column number at which this Token begins. */
readonly column: number;
/**
* For non-punctuation tokens, represents the interpreted value of the token.
*
* Note: is undefined for punctuation tokens, but typed as string for
* convenience in the parser.
*/
readonly value: string;
/**
* Tokens exist as nodes in a double-linked-list amongst all tokens
* including ignored tokens. <SOF> is always the first node and <EOF>
* the last.
*/
readonly prev: Token | null;
/** Next token in the token stream, including ignored tokens. */
readonly next: Token | null;
/**
* Creates a Token instance.
* @param kind - Token kind produced by lexical analysis.
* @param start - Character offset where this token begins.
* @param end - Character offset where this token ends.
* @param line - One-indexed line number where this token begins.
* @param column - One-indexed column number where this token begins.
* @param value - Interpreted value for non-punctuation tokens.
* @example
* ```ts
* import { Token, TokenKind } from 'graphql/language';
*
* const token = new Token(TokenKind.NAME, 2, 7, 1, 3, 'hello');
*
* token.kind; // => TokenKind.NAME
* token.value; // => 'hello'
* token.toJSON(); // => { kind: 'Name', value: 'hello', line: 1, column: 3 }
* ```
*/
constructor(kind: TokenKind, start: number, end: number, line: number, column: number, value?: string);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a JSON representation of this token.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { Lexer, Source } from 'graphql/language';
*
* const lexer = new Lexer(new Source('{ hello }'));
* const token = lexer.advance().toJSON();
*
* token; // => { kind: '{', value: undefined, line: 1, column: 1 }
* ```
*/
toJSON(): {
kind: TokenKind;
value?: string;
line: number;
column: number;
};
}
/** The list of all possible AST node types. */
export type ASTNode = NameNode | DocumentNode | OperationDefinitionNode | VariableDefinitionNode | VariableNode | SelectionSetNode | FieldNode | ArgumentNode | FragmentArgumentNode | FragmentSpreadNode | InlineFragmentNode | FragmentDefinitionNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | NullValueNode | EnumValueNode | ListValueNode | ObjectValueNode | ObjectFieldNode | DirectiveNode | NamedTypeNode | ListTypeNode | NonNullTypeNode | SchemaDefinitionNode | OperationTypeDefinitionNode | ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | FieldDefinitionNode | InputValueDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | EnumValueDefinitionNode | InputObjectTypeDefinitionNode | DirectiveDefinitionNode | SchemaExtensionNode | ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode | DirectiveExtensionNode | TypeCoordinateNode | MemberCoordinateNode | ArgumentCoordinateNode | DirectiveCoordinateNode | DirectiveArgumentCoordinateNode;
/** Utility type listing all nodes indexed by their kind. */
export type ASTKindToNode = {
[NodeT in ASTNode as NodeT["kind"]]: NodeT;
};
/** An identifier in a GraphQL document. */
export interface NameNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["NAME"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Parsed value represented by this node. */
readonly value: string;
}
/** The root AST node for a parsed GraphQL document. */
export interface DocumentNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DOCUMENT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Top-level executable and type-system definitions in this document. */
readonly definitions: ReadonlyArray<DefinitionNode>;
/** The number of lexical tokens parsed for this document, if token counting was enabled. */
readonly tokenCount?: number | undefined;
}
/** Any top-level definition that may appear in a GraphQL document. */
export type DefinitionNode = ExecutableDefinitionNode | TypeSystemDefinitionNode | TypeSystemExtensionNode;
/** Any executable definition that may appear in an operation document. */
export type ExecutableDefinitionNode = OperationDefinitionNode | FragmentDefinitionNode;
/** A query, mutation, or subscription operation definition. */
export interface OperationDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OPERATION_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** The operation selected for execution. */
readonly operation: OperationTypeNode;
/** Name node identifying this AST node. */
readonly name?: NameNode | undefined;
/** Variable definitions declared by this operation or fragment. */
readonly variableDefinitions?: ReadonlyArray<VariableDefinitionNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
/** Selections made by this operation, field, or fragment. */
readonly selectionSet: SelectionSetNode;
}
/**
* A narrowed OperationDefinitionNode for subscription operations.
* Subscription operations go through a distinct execution pipeline
* (source event stream + per-event execution), so narrowing the operation
* type allows functions in that pipeline to accept only valid input.
*/
export interface SubscriptionOperationDefinitionNode extends OperationDefinitionNode {
/** Subscription operation kind for this definition. */
readonly operation: (typeof OperationTypeNode)["SUBSCRIPTION"];
}
/**
* The operation types supported by GraphQL executable definitions.
* @category Kinds
*/
export declare const OperationTypeNode: {
readonly QUERY: "query";
readonly MUTATION: "mutation";
readonly SUBSCRIPTION: "subscription";
};
/**
* The operation types supported by GraphQL executable definitions.
* @category Kinds
*/
export type OperationTypeNode = (typeof OperationTypeNode)[keyof typeof OperationTypeNode];
/** A variable declaration in an operation or experimental fragment definition. */
export interface VariableDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["VARIABLE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** The variable being defined or referenced. */
readonly variable: VariableNode;
/** The GraphQL type reference or runtime type for this element. */
readonly type: TypeNode;
/** Default value used when no explicit value is supplied. */
readonly defaultValue?: ConstValueNode | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** A variable reference, such as `$id`. */
export interface VariableNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["VARIABLE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
}
/** A set of fields and fragments selected from an object, interface, or union. */
export interface SelectionSetNode {
/** The discriminator identifying the concrete AST or introspection kind. */
kind: KindTypeMap["SELECTION_SET"];
/** The source location for this AST node, if location tracking was enabled. */
loc?: Location$1 | undefined;
/** Fields and fragments contained in this selection set. */
selections: ReadonlyArray<SelectionNode>;
}
/** Any selection that may appear inside a selection set. */
export type SelectionNode = FieldNode | FragmentSpreadNode | InlineFragmentNode;
/** A field selected in an executable GraphQL document. */
export interface FieldNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["FIELD"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The response-key alias for this field, if one was supplied. */
readonly alias?: NameNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Arguments supplied to this field, directive, or coordinate. */
readonly arguments?: ReadonlyArray<ArgumentNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
/** Selections made by this operation, field, or fragment. */
readonly selectionSet?: SelectionSetNode | undefined;
}
/** An argument supplied to a field or directive. */
export interface ArgumentNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ARGUMENT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Parsed value represented by this node. */
readonly value: ValueNode;
}
/** An argument node whose value is guaranteed to be constant. */
export interface ConstArgumentNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ARGUMENT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Parsed value represented by this node. */
readonly value: ConstValueNode;
}
/** Variable definition declared by a fragment argument. */
export interface FragmentArgumentNode {
/** AST node kind for a fragment argument. */
readonly kind: KindTypeMap["FRAGMENT_ARGUMENT"];
/** Source location for this fragment argument. */
readonly loc?: Location$1 | undefined;
/** Variable name declared by this fragment argument. */
readonly name: NameNode;
/** Default value literal for this fragment argument, if provided. */
readonly value: ValueNode;
}
/** A named fragment spread, such as `...userFields`. */
export interface FragmentSpreadNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["FRAGMENT_SPREAD"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Argument values supplied to the referenced fragment. */
readonly arguments?: ReadonlyArray<FragmentArgumentNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
}
/** An inline fragment spread with an optional type condition. */
export interface InlineFragmentNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INLINE_FRAGMENT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The type condition that limits where this fragment applies. */
readonly typeCondition?: NamedTypeNode | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
/** Selections made by this operation, field, or fragment. */
readonly selectionSet: SelectionSetNode;
}
/** A reusable fragment definition declared in an executable document. */
export interface FragmentDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["FRAGMENT_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Experimental variable definitions declared by this fragment definition. */
readonly variableDefinitions?: ReadonlyArray<VariableDefinitionNode> | undefined;
/** The type condition that limits where this fragment applies. */
readonly typeCondition: NamedTypeNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
/** Selections made by this operation, field, or fragment. */
readonly selectionSet: SelectionSetNode;
}
/** Any value literal that may appear in an executable GraphQL document. */
export type ValueNode = VariableNode | IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | NullValueNode | EnumValueNode | ListValueNode | ObjectValueNode;
/** Any value literal that is guaranteed not to contain a variable reference. */
export type ConstValueNode = IntValueNode | FloatValueNode | StringValueNode | BooleanValueNode | NullValueNode | EnumValueNode | ConstListValueNode | ConstObjectValueNode;
/** An integer value literal. */
export interface IntValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Parsed value represented by this node. */
readonly value: string;
}
/** A floating-point value literal. */
export interface FloatValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["FLOAT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Parsed value represented by this node. */
readonly value: string;
}
/** A string value literal. */
export interface StringValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["STRING"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Parsed value represented by this node. */
readonly value: string;
/** Whether this string was parsed from block string syntax. */
readonly block?: boolean | undefined;
}
/** A boolean value literal. */
export interface BooleanValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["BOOLEAN"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Parsed value represented by this node. */
readonly value: boolean;
}
/** A null value literal. */
export interface NullValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["NULL"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
}
/** An enum value literal. */
export interface EnumValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ENUM"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Parsed value represented by this node. */
readonly value: string;
}
/** A list value literal. */
export interface ListValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["LIST"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Values contained in this enum, list, or input-object definition. */
readonly values: ReadonlyArray<ValueNode>;
}
/** A list value literal whose elements are all constant values. */
export interface ConstListValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["LIST"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Values contained in this enum, list, or input-object definition. */
readonly values: ReadonlyArray<ConstValueNode>;
}
/** An input object value literal. */
export interface ObjectValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OBJECT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields: ReadonlyArray<ObjectFieldNode>;
}
/** An input object value literal whose fields are all constant values. */
export interface ConstObjectValueNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OBJECT"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields: ReadonlyArray<ConstObjectFieldNode>;
}
/** A field inside an input object value literal. */
export interface ObjectFieldNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OBJECT_FIELD"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Parsed value represented by this node. */
readonly value: ValueNode;
}
/** A field inside a constant input object value literal. */
export interface ConstObjectFieldNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OBJECT_FIELD"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Parsed value represented by this node. */
readonly value: ConstValueNode;
}
/** A directive applied to an executable or type-system location. */
export interface DirectiveNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DIRECTIVE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Arguments supplied to this field, directive, or coordinate. */
readonly arguments?: ReadonlyArray<ArgumentNode> | undefined;
}
/** A directive whose arguments are all constant values. */
export interface ConstDirectiveNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DIRECTIVE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Arguments supplied to this field, directive, or coordinate. */
readonly arguments?: ReadonlyArray<ConstArgumentNode> | undefined;
}
/** Any GraphQL type reference AST node. */
export type TypeNode = NamedTypeNode | ListTypeNode | NonNullTypeNode;
/** A named type reference. */
export interface NamedTypeNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["NAMED_TYPE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
}
/** A list type reference. */
export interface ListTypeNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["LIST_TYPE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The GraphQL type reference or runtime type for this element. */
readonly type: TypeNode;
}
/** A non-null type reference. */
export interface NonNullTypeNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["NON_NULL_TYPE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The GraphQL type reference or runtime type for this element. */
readonly type: NamedTypeNode | ListTypeNode;
}
/** Any type-system definition that may appear in a schema document. */
export type TypeSystemDefinitionNode = SchemaDefinitionNode | TypeDefinitionNode | DirectiveDefinitionNode;
/** A schema definition in a type-system document. */
export interface SchemaDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["SCHEMA_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Root operation types declared by this schema definition or extension. */
readonly operationTypes: ReadonlyArray<OperationTypeDefinitionNode>;
}
/** A root operation type declaration inside a schema definition or extension. */
export interface OperationTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OPERATION_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The operation selected for execution. */
readonly operation: OperationTypeNode;
/** The GraphQL type reference or runtime type for this element. */
readonly type: NamedTypeNode;
}
/** Any named type definition that may appear in a schema document. */
export type TypeDefinitionNode = ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | InputObjectTypeDefinitionNode;
/** A scalar type definition in a type-system document. */
export interface ScalarTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["SCALAR_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** An object type definition in a type-system document. */
export interface ObjectTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OBJECT_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Interfaces implemented by this object or interface type. */
readonly interfaces?: ReadonlyArray<NamedTypeNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields?: ReadonlyArray<FieldDefinitionNode> | undefined;
}
/** A field definition declared by an object or interface type. */
export interface FieldDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["FIELD_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Arguments supplied to this field, directive, or coordinate. */
readonly arguments?: ReadonlyArray<InputValueDefinitionNode> | undefined;
/** The GraphQL type reference or runtime type for this element. */
readonly type: TypeNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** An argument or input-field definition. */
export interface InputValueDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INPUT_VALUE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** The GraphQL type reference or runtime type for this element. */
readonly type: TypeNode;
/** Default value used when no explicit value is supplied. */
readonly defaultValue?: ConstValueNode | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** An interface type definition in a type-system document. */
export interface InterfaceTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INTERFACE_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Interfaces implemented by this object or interface type. */
readonly interfaces?: ReadonlyArray<NamedTypeNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields?: ReadonlyArray<FieldDefinitionNode> | undefined;
}
/** A union type definition in a type-system document. */
export interface UnionTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["UNION_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Object types that belong to this union type. */
readonly types?: ReadonlyArray<NamedTypeNode> | undefined;
}
/** An enum type definition in a type-system document. */
export interface EnumTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ENUM_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Values contained in this enum, list, or input-object definition. */
readonly values?: ReadonlyArray<EnumValueDefinitionNode> | undefined;
}
/** An enum value definition. */
export interface EnumValueDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ENUM_VALUE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** An input object type definition in a type-system document. */
export interface InputObjectTypeDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INPUT_OBJECT_TYPE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields?: ReadonlyArray<InputValueDefinitionNode> | undefined;
}
/** A directive definition in a type-system document. */
export interface DirectiveDefinitionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DIRECTIVE_DEFINITION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** The optional GraphQL description associated with this definition. */
readonly description?: StringValueNode | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Arguments supplied to this field, directive, or coordinate. */
readonly arguments?: ReadonlyArray<InputValueDefinitionNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Whether this directive may appear more than once at the same location. */
readonly repeatable: boolean;
/** Locations where this directive may be applied. */
readonly locations: ReadonlyArray<NameNode>;
}
/** Any type-system extension that may appear in a schema extension document. */
export type TypeSystemExtensionNode = SchemaExtensionNode | TypeExtensionNode | DirectiveExtensionNode;
/** A schema extension in a type-system document. */
export interface SchemaExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["SCHEMA_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Root operation types declared by this schema definition or extension. */
readonly operationTypes?: ReadonlyArray<OperationTypeDefinitionNode> | undefined;
}
/** Any named type extension that may appear in a schema extension document. */
export type TypeExtensionNode = ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode;
/** A scalar type extension. */
export interface ScalarTypeExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["SCALAR_TYPE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** An object type extension. */
export interface ObjectTypeExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["OBJECT_TYPE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Interfaces implemented by this object or interface type. */
readonly interfaces?: ReadonlyArray<NamedTypeNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields?: ReadonlyArray<FieldDefinitionNode> | undefined;
}
/** An interface type extension. */
export interface InterfaceTypeExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INTERFACE_TYPE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Interfaces implemented by this object or interface type. */
readonly interfaces?: ReadonlyArray<NamedTypeNode> | undefined;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields?: ReadonlyArray<FieldDefinitionNode> | undefined;
}
/** A union type extension. */
export interface UnionTypeExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["UNION_TYPE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Object types that belong to this union type. */
readonly types?: ReadonlyArray<NamedTypeNode> | undefined;
}
/** An enum type extension. */
export interface EnumTypeExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ENUM_TYPE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Values contained in this enum, list, or input-object definition. */
readonly values?: ReadonlyArray<EnumValueDefinitionNode> | undefined;
}
/** An input object type extension. */
export interface InputObjectTypeExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["INPUT_OBJECT_TYPE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields?: ReadonlyArray<InputValueDefinitionNode> | undefined;
}
/** A directive extension. */
export interface DirectiveExtensionNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DIRECTIVE_EXTENSION"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1 | undefined;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** Directives available in this schema or applied to this AST node. */
readonly directives?: ReadonlyArray<ConstDirectiveNode> | undefined;
}
/** Any AST node representing a GraphQL schema coordinate. */
export type SchemaCoordinateNode = TypeCoordinateNode | MemberCoordinateNode | ArgumentCoordinateNode | DirectiveCoordinateNode | DirectiveArgumentCoordinateNode;
/** A schema coordinate that refers to a named type. */
export interface TypeCoordinateNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["TYPE_COORDINATE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1;
/** Name node identifying this AST node. */
readonly name: NameNode;
}
/** A schema coordinate that refers to a member of a named type. */
export interface MemberCoordinateNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["MEMBER_COORDINATE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** The member name referenced by this schema coordinate. */
readonly memberName: NameNode;
}
/** A schema coordinate that refers to a field or directive argument. */
export interface ArgumentCoordinateNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["ARGUMENT_COORDINATE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** The field name referenced by this schema coordinate. */
readonly fieldName: NameNode;
/** The argument name referenced by this schema coordinate. */
readonly argumentName: NameNode;
}
/** A schema coordinate that refers to a directive. */
export interface DirectiveCoordinateNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DIRECTIVE_COORDINATE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1;
/** Name node identifying this AST node. */
readonly name: NameNode;
}
/** A schema coordinate that refers to a directive argument. */
export interface DirectiveArgumentCoordinateNode {
/** The discriminator identifying the concrete AST or introspection kind. */
readonly kind: KindTypeMap["DIRECTIVE_ARGUMENT_COORDINATE"];
/** The source location for this AST node, if location tracking was enabled. */
readonly loc?: Location$1;
/** Name node identifying this AST node. */
readonly name: NameNode;
/** The argument name referenced by this schema coordinate. */
readonly argumentName: NameNode;
}
/** Represents a location in a Source. */
export interface SourceLocation {
/** One-indexed line number in the source document. */
readonly line: number;
/** One-indexed column number in the source document. */
readonly column: number;
}
/**
* Takes a Source and a UTF-8 character offset, and returns the corresponding
* line and column as a SourceLocation.
* @param source - The source document that contains the position.
* @param position - The UTF-8 character offset in the source body.
* @returns The 1-indexed line and column for the given source position.
* @example
* ```ts
* import { Source, getLocation } from 'graphql/language';
*
* const source = new Source('type Query { hello: String }');
* const location = getLocation(source, 13);
*
* location; // => { line: 1, column: 14 }
* ```
*/
export declare function getLocation(source: Source, position: number): SourceLocation;
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLErrorExtensions {
[attributeName: string]: unknown;
}
/**
* Custom formatted extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLFormattedErrorExtensions {
[attributeName: string]: unknown;
}
/** Options used to construct a GraphQLError. */
export interface GraphQLErrorOptions {
/** AST node or nodes associated with this error. */
nodes?: ReadonlyArray<ASTNode> | ASTNode | null | undefined;
/** Source document used to derive error locations. */
source?: Maybe<Source>;
/** Character offsets in the source document associated with this error. */
positions?: Maybe<ReadonlyArray<number>>;
/** Response path where this error occurred during execution. */
path?: Maybe<ReadonlyArray<string | number>>;
/**
* Original error that caused this GraphQLError, if one exists.
* Deprecated in favor of `cause` to better align with JavaScript standards.
* @deprecated Prefer `cause` instead.
*/
originalError?: Maybe<Error & {
readonly extensions?: unknown;
}>;
/** Cause of this GraphQLError, if one exists. */
cause?: unknown;
/** Extension fields to include in the formatted result. */
extensions?: Maybe<GraphQLErrorExtensions>;
}
/**
* A GraphQLError describes an Error found during the parse, validate, or
* execute phases of performing a GraphQL operation. In addition to a message
* and stack trace, it also includes information about the locations in a
* GraphQL document and/or execution result that correspond to the Error.
*/
export declare class GraphQLError extends Error {
/**
* An array of `{ line, column }` locations within the source GraphQL document
* which correspond to this error.
*
* Errors during validation often contain multiple locations, for example to
* point out two things with the same name. Errors during execution include a
* single location, the field which produced the error.
*
* Enumerable, and appears in the result of JSON.stringify().
*/
readonly locations: ReadonlyArray<SourceLocation> | undefined;
/**
* An array describing the JSON-path into the execution response which
* corresponds to this error. Only included for errors during execution.
*
* Enumerable, and appears in the result of JSON.stringify().
*/
readonly path: ReadonlyArray<string | number> | undefined;
/** An array of GraphQL AST Nodes corresponding to this error. */
readonly nodes: ReadonlyArray<ASTNode> | undefined;
/**
* The source GraphQL document for the first location of this error.
*
* Note that if this Error represents more than one node, the source may not
* represent nodes after the first node.
*/
readonly source: Source | undefined;
/**
* An array of character offsets within the source GraphQL document
* which correspond to this error.
*/
readonly positions: ReadonlyArray<number> | undefined;
/**
* Original error that caused this GraphQLError, if one exists.
* Deprecated in favor of `cause` to better align with JavaScript standards.
* @deprecated Use `cause` instead.
*/
readonly originalError: Error | undefined;
/** Extension fields to add to the formatted error. */
readonly extensions: GraphQLErrorExtensions;
/**
* Creates a GraphQLError instance.
* @param message - Human-readable error message.
* @param options - Error metadata such as source locations, response path, cause, original error, and extensions.
* @example
* ```ts
* // Create an error from AST nodes and response metadata.
* import { parse } from 'graphql/language';
* import { GraphQLError } from 'graphql/error';
*
* const document = parse('{ greeting }');
* const fieldNode = document.definitions[0].selectionSet.selections[0];
* const error = new GraphQLError('Cannot query this field.', {
* nodes: fieldNode,
* path: ['greeting'],
* extensions: { code: 'FORBIDDEN' },
* });
*
* error.message; // => 'Cannot query this field.'
* error.locations; // => [{ line: 1, column: 3 }]
* error.path; // => ['greeting']
* error.extensions; // => { code: 'FORBIDDEN' }
* ```
* @example
* ```ts
* // This variant derives locations from source positions and preserves the cause.
* import { Source } from 'graphql/language';
* import { GraphQLError } from 'graphql/error';
*
* const source = new Source('{ greeting }');
* const cause = new Error('Database unavailable.');
* const error = new GraphQLError('Resolver failed.', {
* source,
* positions: [2],
* path: ['greeting'],
* cause,
* });
*
* error.locations; // => [{ line: 1, column: 3 }]
* error.path; // => ['greeting']
* error.cause; // => cause
* ```
*/
constructor(message: string, options?: GraphQLErrorOptions);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns this error as a human-readable message with source locations.
* @returns The formatted error string.
* @example
* ```ts
* import { Source } from 'graphql/language';
* import { GraphQLError } from 'graphql/error';
*
* const error = new GraphQLError('Cannot query field "name".', {
* source: new Source('{ name }'),
* positions: [2],
* });
*
* error.toString(); // => 'Cannot query field "name".\n\nGraphQL request:1:3\n1 | { name }\n | ^'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLError } from 'graphql/error';
*
* const error = new GraphQLError('Resolver failed.', {
* path: ['viewer', 'name'],
* extensions: { code: 'INTERNAL' },
* });
*
* error.toJSON(); // => { message: 'Resolver failed.', path: ['viewer', 'name'], extensions: { code: 'INTERNAL' } }
* ```
*/
toJSON(): GraphQLFormattedError;
}
/** See: https://spec.graphql.org/draft/#sec-Errors */
export interface GraphQLFormattedError {
/**
* A short, human-readable summary of the problem that **SHOULD NOT** change
* from occurrence to occurrence of the problem, except for purposes of
* localization.
*/
readonly message: string;
/**
* If an error can be associated to a particular point in the requested
* GraphQL document, it should contain a list of locations.
*/
readonly locations?: ReadonlyArray<SourceLocation>;
/**
* If an error can be associated to a particular field in the GraphQL result,
* it _must_ contain an entry with the key `path` that details the path of
* the response field which experienced the error. This allows clients to
* identify whether a null result is intentional or caused by a runtime error.
*/
readonly path?: ReadonlyArray<string | number>;
/**
* Reserved for implementors to extend the protocol however they see fit,
* and hence there are no additional restrictions on its contents.
*/
readonly extensions?: GraphQLFormattedErrorExtensions;
}
/** Represents a linked response path from a field back to the root response. */
interface Path {
/** The previous segment in the linked response path, or undefined at the root. */
readonly prev: Path | undefined;
/** The field name or list index for this response path segment. */
readonly key: string | number;
/** The runtime object type name associated with this path segment, if known. */
readonly typename: string | undefined;
}
/**
* Given a Path, return an Array of the path keys.
* @param path - The linked response path to flatten.
* @returns An array of response path keys from root to leaf.
* @example
* ```ts
* import { pathToArray } from 'graphql/jsutils/Path';
*
* const path = {
* prev: {
* prev: {
* prev: undefined,
* key: 'viewer',
* typename: 'Query',
* },
* key: 'friends',
* typename: 'User',
* },
* key: 0,
* typename: undefined,
* };
*
* pathToArray(path); // => ['viewer', 'friends', 0]
* pathToArray(undefined); // => []
* ```
*/
declare function pathToArray(path: Maybe<Readonly<Path>>): Array<string | number>;
type PromiseOrValue<T> = Promise<T> | T;
/** @category Kinds */
/** The set of allowed directive location values. */
export declare const DirectiveLocation: {
/** Directive location for query operations. */
readonly QUERY: "QUERY";
/** Directive location for mutation operations. */
readonly MUTATION: "MUTATION";
/** Directive location for subscription operations. */
readonly SUBSCRIPTION: "SUBSCRIPTION";
/** Directive location for field selections. */
readonly FIELD: "FIELD";
/** Directive location for fragment definitions. */
readonly FRAGMENT_DEFINITION: "FRAGMENT_DEFINITION";
/** Directive location for fragment spreads. */
readonly FRAGMENT_SPREAD: "FRAGMENT_SPREAD";
/** Directive location for inline fragments. */
readonly INLINE_FRAGMENT: "INLINE_FRAGMENT";
/** Directive location for variable definitions. */
readonly VARIABLE_DEFINITION: "VARIABLE_DEFINITION";
/** Directive location for fragment variable definitions. */
readonly FRAGMENT_VARIABLE_DEFINITION: "FRAGMENT_VARIABLE_DEFINITION";
/** Directive location for schema definitions and extensions. */
readonly SCHEMA: "SCHEMA";
/** Directive location for scalar type definitions and extensions. */
readonly SCALAR: "SCALAR";
/** Directive location for object type definitions and extensions. */
readonly OBJECT: "OBJECT";
/** Directive location for field definitions. */
readonly FIELD_DEFINITION: "FIELD_DEFINITION";
/** Directive location for argument definitions. */
readonly ARGUMENT_DEFINITION: "ARGUMENT_DEFINITION";
/** Directive location for interface type definitions and extensions. */
readonly INTERFACE: "INTERFACE";
/** Directive location for union type definitions and extensions. */
readonly UNION: "UNION";
/** Directive location for enum type definitions and extensions. */
readonly ENUM: "ENUM";
/** Directive location for enum value definitions. */
readonly ENUM_VALUE: "ENUM_VALUE";
/** Directive location for input object type definitions and extensions. */
readonly INPUT_OBJECT: "INPUT_OBJECT";
/** Directive location for input object field definitions. */
readonly INPUT_FIELD_DEFINITION: "INPUT_FIELD_DEFINITION";
/** Directive location for directive definitions and extensions. */
readonly DIRECTIVE_DEFINITION: "DIRECTIVE_DEFINITION";
};
/** The set of allowed directive location values. */
export type DirectiveLocation = (typeof DirectiveLocation)[keyof typeof DirectiveLocation];
/**
* Test if the given value is a GraphQL directive.
* @param directive - Value to inspect.
* @returns True when the value is a GraphQLDirective.
* @example
* ```ts
* import { DirectiveLocation } from 'graphql/language';
* import { GraphQLDirective, GraphQLString, isDirective } from 'graphql/type';
*
* const upper = new GraphQLDirective({
* name: 'upper',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* });
*
* isDirective(upper); // => true
* isDirective(GraphQLString); // => false
* ```
*/
export declare function isDirective(directive: unknown): directive is GraphQLDirective;
/**
* Returns the value as a GraphQLDirective, or throws if it is not a directive.
* @param directive - Value to inspect.
* @returns The value typed as a GraphQLDirective.
* @example
* ```ts
* import { DirectiveLocation } from 'graphql/language';
* import { assertDirective, GraphQLDirective, GraphQLString } from 'graphql/type';
*
* const upper = new GraphQLDirective({
* name: 'upper',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* });
*
* assertDirective(upper); // => upper
* assertDirective(GraphQLString); // throws an error
* ```
*/
export declare function assertDirective(directive: unknown): GraphQLDirective;
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLDirectiveExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Directives are used by the GraphQL runtime as a way of modifying execution
* behavior. Type system creators will usually not create these directly.
*/
export declare class GraphQLDirective implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Locations where this directive may be applied. */
locations: ReadonlyArray<DirectiveLocation>;
/** Arguments accepted by this field or directive. */
args: ReadonlyArray<GraphQLArgument>;
/** Whether this directive may appear more than once at the same location. */
isRepeatable: boolean;
/** Reason this element is deprecated, if one was provided. */
deprecationReason: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLDirectiveExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<DirectiveDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<DirectiveExtensionNode>;
/**
* Creates a GraphQLDirective instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* import { DirectiveLocation, parse } from 'graphql/language';
* import {
* GraphQLBoolean,
* GraphQLDirective,
* GraphQLInt,
* GraphQLNonNull,
* } from 'graphql/type';
*
* const document = parse(`
* directive @cacheControl(maxAge: Int) repeatable on FIELD_DEFINITION
* extend directive @cacheControl(maxAge: Int) on FIELD_DEFINITION
* `);
* const definition = document.definitions[0];
*
* const cacheControl = new GraphQLDirective({
* name: 'cacheControl',
* description: 'Controls HTTP cache hints for a field.',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* args: {
* inheritMaxAge: {
* description: 'Inherit the parent cache hint.',
* type: new GraphQLNonNull(GraphQLBoolean),
* default: { value: false },
* deprecationReason: 'Use maxAge instead.',
* extensions: { scope: 'cache' },
* },
* maxAge: {
* type: GraphQLInt,
* astNode: definition.arguments[0],
* },
* },
* isRepeatable: true,
* deprecationReason: 'Use @cache instead.',
* extensions: { scope: 'cache' },
* astNode: definition,
* extensionASTNodes: [document.definitions[1]],
* });
*
* cacheControl.name; // => 'cacheControl'
* cacheControl.description; // => 'Controls HTTP cache hints for a field.'
* cacheControl.args[0].name; // => 'inheritMaxAge'
* cacheControl.args[0].default.value; // => false
* cacheControl.isRepeatable; // => true
* cacheControl.extensions; // => { scope: 'cache' }
* ```
*/
constructor(config: Readonly<GraphQLDirectiveConfig>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import { DirectiveLocation } from 'graphql/language';
* import { GraphQLDirective, GraphQLString } from 'graphql/type';
*
* const tag = new GraphQLDirective({
* name: 'tag',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* args: {
* name: { type: GraphQLString },
* },
* });
*
* const config = tag.toConfig();
* const tagCopy = new GraphQLDirective(config);
*
* config.args.name.type; // => GraphQLString
* tagCopy.args[0].name; // => 'name'
* ```
*/
toConfig(): GraphQLDirectiveNormalizedConfig;
/**
* Returns the schema coordinate identifying this directive.
* @returns The directive schema coordinate.
* @example
* ```ts
* import { DirectiveLocation } from 'graphql/language';
* import { GraphQLDirective } from 'graphql/type';
*
* const tag = new GraphQLDirective({
* name: 'tag',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* });
*
* tag.toString(); // => '@tag'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { DirectiveLocation } from 'graphql/language';
* import { GraphQLDirective } from 'graphql/type';
*
* const tag = new GraphQLDirective({
* name: 'tag',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* });
*
* tag.toJSON(); // => '@tag'
* JSON.stringify({ directive: tag }); // => '{"directive":"@tag"}'
* ```
*/
toJSON(): string;
}
/** Configuration used to construct a GraphQLDirective. */
export interface GraphQLDirectiveConfig {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Locations where this directive may be applied. */
locations: ReadonlyArray<DirectiveLocation>;
/** Arguments accepted by this field or directive. */
args?: Maybe<ObjMap<GraphQLArgumentConfig>>;
/** Whether this directive may appear more than once at the same location. */
isRepeatable?: Maybe<boolean>;
/** Reason this element is deprecated, if one was provided. */
deprecationReason?: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLDirectiveExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<DirectiveDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<DirectiveExtensionNode>>;
}
interface GraphQLDirectiveNormalizedConfig extends GraphQLDirectiveConfig {
args: GraphQLFieldNormalizedConfigArgumentMap;
isRepeatable: boolean;
extensions: Readonly<GraphQLDirectiveExtensions>;
extensionASTNodes: ReadonlyArray<DirectiveExtensionNode>;
}
/** Used to conditionally include fields or fragments. */
export declare const GraphQLIncludeDirective: GraphQLDirective;
/** Used to conditionally skip (exclude) fields or fragments. */
export declare const GraphQLSkipDirective: GraphQLDirective;
/**
* Experimental directive used to conditionally defer fragments.
*
* This directive is exported for schemas that explicitly opt in to incremental
* delivery. It is not included in `specifiedDirectives`.
*/
export declare const GraphQLDeferDirective: GraphQLDirective;
/**
* Experimental directive used to conditionally stream list fields.
*
* This directive is exported for schemas that explicitly opt in to incremental
* delivery. It is not included in `specifiedDirectives`.
*/
export declare const GraphQLStreamDirective: GraphQLDirective;
/** Constant string used for default reason for a deprecation. */
export declare const DEFAULT_DEPRECATION_REASON = "No longer supported";
/**
* Used to declare element of a GraphQL schema as deprecated.
*
* The `reason` argument is non-null and defaults to
* `DEFAULT_DEPRECATION_REASON`.
*/
export declare const GraphQLDeprecatedDirective: GraphQLDirective;
/** Used to provide a URL for specifying the behavior of custom scalar definitions. */
export declare const GraphQLSpecifiedByDirective: GraphQLDirective;
/** Used to indicate an Input Object is a OneOf Input Object. */
export declare const GraphQLOneOfDirective: GraphQLDirective;
/**
* Full list of stable directives specified by GraphQL.js.
*
* Experimental `@defer` and `@stream` are exported separately and are not
* included in this list.
*/
export declare const specifiedDirectives: ReadonlyArray<GraphQLDirective>;
/**
* Returns true when the directive is one of the directives specified by GraphQL.
* @param directive - Directive to inspect.
* @returns True when the directive is specified by GraphQL.
* @example
* ```ts
* import {
* GraphQLDirective,
* GraphQLIncludeDirective,
* isSpecifiedDirective,
* } from 'graphql/type';
* import { DirectiveLocation } from 'graphql/language';
*
* const customDirective = new GraphQLDirective({
* name: 'auth',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* });
*
* isSpecifiedDirective(GraphQLIncludeDirective); // => true
* isSpecifiedDirective(customDirective); // => false
* ```
*/
export declare function isSpecifiedDirective(directive: GraphQLDirective): boolean;
/**
* Maximum possible Int value as per GraphQL Spec (32-bit signed integer).
* n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe up-to 2^53 - 1
*/
export declare const GRAPHQL_MAX_INT = 2147483647;
/**
* Minimum possible Int value as per GraphQL Spec (32-bit signed integer).
* n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe starting at -(2^53 - 1)
*/
export declare const GRAPHQL_MIN_INT = -2147483648;
/** The built-in `Int` scalar type. */
export declare const GraphQLInt: GraphQLScalarType<number>;
/** The built-in `Float` scalar type. */
export declare const GraphQLFloat: GraphQLScalarType<number>;
/** The built-in `String` scalar type. */
export declare const GraphQLString: GraphQLScalarType<string>;
/** The built-in `Boolean` scalar type. */
export declare const GraphQLBoolean: GraphQLScalarType<boolean>;
/** The built-in `ID` scalar type. */
export declare const GraphQLID: GraphQLScalarType<string>;
/** All built-in scalar types defined by the GraphQL specification. */
export declare const specifiedScalarTypes: ReadonlyArray<GraphQLScalarType>;
/**
* Returns true when the scalar type is one of the scalars specified by GraphQL.
* @param type - The GraphQL type to inspect.
* @returns True when the scalar type is one of the scalars specified by GraphQL.
* @example
* ```ts
* import {
* GraphQLScalarType,
* GraphQLString,
* isSpecifiedScalarType,
* } from 'graphql/type';
*
* const DateTime = new GraphQLScalarType({
* name: 'DateTime',
* });
*
* isSpecifiedScalarType(GraphQLString); // => true
* isSpecifiedScalarType(DateTime); // => false
* ```
*/
export declare function isSpecifiedScalarType(type: GraphQLNamedType): boolean;
/** The introspection type describing a GraphQL schema. */
export declare const __Schema: GraphQLObjectType;
/** The introspection type describing a GraphQL directive. */
export declare const __Directive: GraphQLObjectType;
/** The introspection enum describing directive locations. */
export declare const __DirectiveLocation: GraphQLEnumType;
/** The introspection type describing GraphQL types. */
export declare const __Type: GraphQLObjectType;
/** The introspection type describing object and interface fields. */
export declare const __Field: GraphQLObjectType;
/** The introspection type describing arguments and input fields. */
export declare const __InputValue: GraphQLObjectType;
/** The introspection type describing enum values. */
export declare const __EnumValue: GraphQLObjectType;
/**
* The introspection enum describing the different kinds of GraphQL types.
* @category Introspection
*/
export declare const TypeKind: {
readonly SCALAR: "SCALAR";
readonly OBJECT: "OBJECT";
readonly INTERFACE: "INTERFACE";
readonly UNION: "UNION";
readonly ENUM: "ENUM";
readonly INPUT_OBJECT: "INPUT_OBJECT";
readonly LIST: "LIST";
readonly NON_NULL: "NON_NULL";
};
/**
* The introspection enum describing the different kinds of GraphQL types.
* @category Introspection
*/
export type TypeKind = (typeof TypeKind)[keyof typeof TypeKind];
/** The introspection enum describing GraphQL type kinds. */
export declare const __TypeKind: GraphQLEnumType;
/**
* Note that these are GraphQLField and not GraphQLFieldConfig,
* so the format for args is different.
*/
export declare const SchemaMetaFieldDef: GraphQLField<unknown, unknown>;
/** The `__type` meta field definition used by introspection. */
export declare const TypeMetaFieldDef: GraphQLField<unknown, unknown>;
/** The `__typename` meta field definition used by execution and introspection. */
export declare const TypeNameMetaFieldDef: GraphQLField<unknown, unknown>;
/** All introspection types defined by the GraphQL specification. */
export declare const introspectionTypes: ReadonlyArray<GraphQLNamedType>;
/**
* Returns true when the type is one of the built-in introspection types.
* @param type - The GraphQL type to inspect.
* @returns True when the type is one of the built-in introspection types.
* @example
* ```ts
* import { GraphQLString, isIntrospectionType, __Type } from 'graphql/type';
*
* isIntrospectionType(__Type); // => true
* isIntrospectionType(GraphQLString); // => false
* ```
*/
export declare function isIntrospectionType(type: GraphQLNamedType): boolean;
/**
* Implements the "Type Validation" sub-sections of the specification's
* "Type System" section.
*
* Validation runs synchronously, returning an array of encountered errors, or
* an empty array if no errors were encountered and the Schema is valid.
* @param schema - GraphQL schema to use.
* @returns Schema validation errors, or an empty array when the schema is valid.
* @example
* ```ts
* import { validateSchema } from 'graphql/type';
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
* const errors = validateSchema(schema);
*
* errors; // => []
* ```
*/
export declare function validateSchema(schema: GraphQLSchema): ReadonlyArray<GraphQLError>;
/**
* Utility function which asserts a schema is valid by throwing an error if
* it is invalid.
* @param schema - GraphQL schema to use.
* @example
* ```ts
* import { assertValidSchema } from 'graphql/type';
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* assertValidSchema(schema); // does not throw
* ```
*/
export declare function assertValidSchema(schema: GraphQLSchema): void;
/** @category Names */
/**
* Upholds the spec rules about naming.
* @param name - The GraphQL name to validate.
* @returns The validated GraphQL name.
* @example
* ```ts
* import { assertName } from 'graphql/type';
*
* assertName('User'); // => 'User'
* assertName('123User'); // throws an error
* ```
*/
export declare function assertName(name: string): string;
/**
* Upholds the spec rules about naming enum values.
* @param name - The GraphQL name to validate.
* @returns The validated GraphQL name.
* @example
* ```ts
* import { assertEnumValueName } from 'graphql/type';
*
* assertEnumValueName('ACTIVE'); // => 'ACTIVE'
* assertEnumValueName('true'); // throws an error
* ```
*/
export declare function assertEnumValueName(name: string): string;
interface GraphQLVariableSignature {
name: string;
type: GraphQLInputType;
defaultValue?: never;
default: {
literal: ConstValueNode;
} | undefined;
}
interface FragmentVariableValues {
readonly sources: ReadOnlyObjMap<FragmentVariableValueSource>;
readonly coerced: ReadOnlyObjMap<unknown>;
}
interface FragmentVariableValueSource {
readonly signature: GraphQLVariableSignature;
readonly value?: ValueNode;
readonly fragmentVariableValues?: FragmentVariableValues;
}
interface FragmentDetails {
definition: FragmentDefinitionNode;
variableSignatures?: ObjMap<GraphQLVariableSignature> | undefined;
}
/**
* Coerced variable values prepared for execution.
*
* The `coerced` map contains runtime values keyed by variable name. The
* `sources` map records whether each value came from request input, an operation
* default, or a fragment-variable default so utilities can preserve defaults
* when replacing variables in literals.
*/
export interface VariableValues {
/** Source metadata for each variable value keyed by variable name. */
readonly sources: ReadOnlyObjMap<VariableValueSource>;
/** Coerced runtime variable values keyed by variable name. */
readonly coerced: ReadOnlyObjMap<unknown>;
}
interface VariableValueSource {
readonly signature: GraphQLVariableSignature;
readonly value?: unknown;
}
type VariableValuesOrErrors = {
variableValues: VariableValues;
errors?: never;
} | {
errors: ReadonlyArray<GraphQLError>;
variableValues?: never;
};
/**
* Prepares an object map of variableValues of the correct type based on the
* provided variable definitions and arbitrary input. If the input cannot be
* parsed to match the variable definitions, GraphQLError values are returned.
*
* Note: Returned maps use null prototypes to avoid collisions with
* Object prototype properties.
* @param schema - GraphQL schema to use.
* @param varDefNodes - The variable definition AST nodes to coerce.
* @param inputs - The runtime variable values keyed by variable name.
* @param options - Optional configuration for this operation.
* @param [options.maxErrors] - Maximum number of coercion errors to report.
* @param [options.hideSuggestions] - Whether suggestion text should be omitted
* from errors.
* @returns Coerced variable values with source metadata, or request errors.
* @example
* ```ts
* // Coerce provided variables and apply operation defaults.
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { getVariableValues } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* reviews(stars: Int!, limit: Int = 10): [String]
* }
* `);
* const document = parse(`
* query ($stars: Int!, $limit: Int = 10) {
* reviews(stars: $stars, limit: $limit)
* }
* `);
* const operation = document.definitions[0];
*
* const result = getVariableValues(schema, operation.variableDefinitions, {
* stars: '5',
* });
*
* assert('variableValues' in result);
*
* result.variableValues.coerced; // => { stars: 5, limit: 10 }
* ```
* @example
* ```ts
* // This variant uses maxErrors to cap reported coercion errors.
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { getVariableValues } from 'graphql/execution';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput!): String
* }
* `);
* const document = parse(`
* query ($first: ReviewInput!, $second: ReviewInput!) {
* first: review(input: $first)
* second: review(input: $second)
* }
* `);
* const operation = document.definitions[0];
*
* const result = getVariableValues(
* schema,
* operation.variableDefinitions,
* { first: { stars: 'bad' }, second: { stars: 'also bad' } },
* { maxErrors: 1 },
* );
*
* assert('errors' in result);
*
* result.errors.length; // => 2
* result.errors[1].message; // matches /error limit reached/
* ```
*/
export declare function getVariableValues(schema: GraphQLSchema, varDefNodes: ReadonlyArray<VariableDefinitionNode>, inputs: {
readonly [variable: string]: unknown;
}, options?: {
maxErrors?: number;
hideSuggestions?: boolean;
}): VariableValuesOrErrors;
/**
* Prepares an object map of argument values given a list of argument
* definitions and list of argument AST nodes.
*
* Note: Returned value uses a null prototype to avoid collisions with
* JavaScript's own property names.
* @param def - Field or directive definition that declares the arguments.
* @param node - Field or directive AST node supplying argument literals.
* @param variableValues - Operation variable values returned by getVariableValues.
* @param fragmentVariableValues - Fragment variable values for the current fragment scope.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns A map of coerced argument values.
* @example
* ```ts
* // Read literal argument values and defaults.
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { getArgumentValues } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* reviews(stars: Int!, limit: Int = 10): [String]
* }
* `);
* const fieldDef = schema.getQueryType().getFields().reviews;
* const document = parse('{ reviews(stars: 5) }');
* const fieldNode = document.definitions[0].selectionSet.selections[0];
*
* getArgumentValues(fieldDef, fieldNode); // => { stars: 5, limit: 10 }
* ```
* @example
* ```ts
* // This variant resolves argument values from operation variables.
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { getArgumentValues, getVariableValues } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* reviews(stars: Int!): [String]
* }
* `);
* const fieldDef = schema.getQueryType().getFields().reviews;
* const document = parse('query ($stars: Int!) { reviews(stars: $stars) }');
* const operation = document.definitions[0];
* const fieldNode = document.definitions[0].selectionSet.selections[0];
* const variables = getVariableValues(schema, operation.variableDefinitions, {
* stars: '5',
* });
*
* assert('variableValues' in variables);
*
* getArgumentValues(fieldDef, fieldNode, variables.variableValues); // => { stars: 5 }
* getArgumentValues(fieldDef, fieldNode); // throws an error
* ```
*/
export declare function getArgumentValues(def: GraphQLField<unknown, unknown> | GraphQLDirective, node: FieldNode | DirectiveNode, variableValues?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>, hideSuggestions?: Maybe<boolean>): ObjMap<unknown>;
/**
* Prepares an object map of argument values given a directive definition
* and a AST node which may contain directives. Optionally also accepts a map
* of variable values.
*
* If the directive does not exist on the node, returns undefined.
*
* Note: Returned value uses a null prototype to avoid collisions with
* JavaScript's own property names.
* @param directiveDef - Directive definition to read argument definitions from.
* @param node - AST node that may contain directives.
* @param node.directives - The directives on the AST node.
* @param variableValues - Operation variable values returned by getVariableValues.
* @param fragmentVariableValues - Fragment variable values for the current fragment scope.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns A map of coerced directive argument values, or undefined when absent.
* @example
* ```ts
* // Read literal directive arguments from a node.
* import { parse } from 'graphql/language';
* import { GraphQLSkipDirective } from 'graphql/type';
* import { getDirectiveValues } from 'graphql/execution';
*
* const document = parse('{ name @skip(if: true) }');
* const fieldNode = document.definitions[0].selectionSet.selections[0];
*
* getDirectiveValues(GraphQLSkipDirective, fieldNode); // => { if: true }
* ```
* @example
* ```ts
* // This variant resolves directive arguments from variables and handles absent directives.
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { GraphQLIncludeDirective } from 'graphql/type';
* import { buildSchema } from 'graphql/utilities';
* import { getDirectiveValues, getVariableValues } from 'graphql/execution';
*
* const schema = buildSchema('type Query { name: String }');
* const document = parse(
* 'query ($includeName: Boolean!) { name @include(if: $includeName) }',
* );
* const operation = document.definitions[0];
* const fieldNode = document.definitions[0].selectionSet.selections[0];
* const variables = getVariableValues(schema, operation.variableDefinitions, {
* includeName: false,
* });
*
* assert('variableValues' in variables);
*
* getDirectiveValues(
* GraphQLIncludeDirective,
* fieldNode,
* variables.variableValues,
* ); // => { if: false }
* getDirectiveValues(GraphQLIncludeDirective, { directives: [] }); // => undefined
* ```
*/
export declare function getDirectiveValues(directiveDef: GraphQLDirective, node: {
readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
}, variableValues?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>, hideSuggestions?: Maybe<boolean>): undefined | ObjMap<unknown>;
/** These are all of the possible kinds of types. */
export type GraphQLType = GraphQLNamedType | GraphQLWrappingType;
/**
* Returns true when the value is any GraphQL type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is any GraphQL type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { GraphQLList, GraphQLString, isType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* isType(GraphQLString); // => true
* isType(new GraphQLList(GraphQLString)); // => true
* isType(schema.getType('Query')); // => true
* isType('String'); // => false
* ```
*/
export declare function isType(type: unknown): type is GraphQLType;
/**
* Returns the value as a GraphQL type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const queryType = assertType(schema.getType('Query'));
*
* queryType.toString(); // => 'Query'
* assertType('Query'); // throws an error
* ```
*/
export declare function assertType(type: unknown): GraphQLType;
/**
* There are predicates for each kind of GraphQL type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLScalarType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isScalarType } from 'graphql/type';
*
* const schema = buildSchema(`
* scalar DateTime
*
* type Query {
* createdAt: DateTime
* }
* `);
*
* isScalarType(schema.getType('DateTime')); // => true
* isScalarType(schema.getType('Query')); // => false
* ```
*/
export declare function isScalarType(type: unknown): type is GraphQLScalarType;
/**
* Returns the value as a GraphQLScalarType, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLScalarType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertScalarType } from 'graphql/type';
*
* const schema = buildSchema(`
* scalar DateTime
*
* type Query {
* createdAt: DateTime
* }
* `);
*
* const dateTimeType = assertScalarType(schema.getType('DateTime'));
*
* dateTimeType.name; // => 'DateTime'
* assertScalarType(schema.getType('Query')); // throws an error
* ```
*/
export declare function assertScalarType(type: unknown): GraphQLScalarType;
/**
* Returns true when the value is a GraphQLObjectType.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLObjectType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type User {
* name: String
* }
*
* type Query {
* user: User
* }
* `);
*
* isObjectType(schema.getType('User')); // => true
* isObjectType(schema.getType('ReviewInput')); // => false
* ```
*/
export declare function isObjectType(type: unknown): type is GraphQLObjectType;
/**
* Returns the value as a GraphQLObjectType, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLObjectType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type User {
* name: String
* }
*
* type Query {
* user: User
* }
* `);
*
* const userType = assertObjectType(schema.getType('User'));
*
* Object.keys(userType.getFields()); // => ['name']
* assertObjectType(schema.getType('ReviewInput')); // throws an error
* ```
*/
export declare function assertObjectType(type: unknown): GraphQLObjectType;
/**
* Returns true when the value is a resolved GraphQL field definition.
* @param field - Value to inspect.
* @returns True when the value is a GraphQLField.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isField } from 'graphql/type';
*
* const schema = buildSchema('type Query { greeting: String }');
* const field = schema.getQueryType().getFields().greeting;
*
* isField(field); // => true
* isField(schema.getQueryType()); // => false
* ```
*/
export declare function isField(field: unknown): field is GraphQLField;
/**
* Returns the value as a GraphQLField, or throws if it is not one.
* @param field - Value to inspect.
* @returns The value typed as a GraphQLField.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertField } from 'graphql/type';
*
* const schema = buildSchema('type Query { greeting: String }');
* const field = assertField(schema.getQueryType().getFields().greeting);
*
* field.name; // => 'greeting'
* assertField(schema.getQueryType()); // throws an error
* ```
*/
export declare function assertField(field: unknown): GraphQLField;
/**
* Returns true when the value is a resolved GraphQL argument definition.
* @param arg - Value to inspect.
* @returns True when the value is a GraphQLArgument.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isArgument } from 'graphql/type';
*
* const schema = buildSchema('type Query { greeting(name: String): String }');
* const arg = schema.getQueryType().getFields().greeting.args[0];
*
* isArgument(arg); // => true
* isArgument(schema.getQueryType()); // => false
* ```
*/
export declare function isArgument(arg: unknown): arg is GraphQLArgument;
/**
* Returns the value as a GraphQLArgument, or throws if it is not one.
* @param arg - Value to inspect.
* @returns The value typed as a GraphQLArgument.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertArgument } from 'graphql/type';
*
* const schema = buildSchema('type Query { greeting(name: String): String }');
* const arg = assertArgument(schema.getQueryType().getFields().greeting.args[0]);
*
* arg.name; // => 'name'
* assertArgument(schema.getQueryType()); // throws an error
* ```
*/
export declare function assertArgument(arg: unknown): GraphQLArgument;
/**
* Returns true when the value is a GraphQLInterfaceType.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLInterfaceType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isInterfaceType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
*
* isInterfaceType(schema.getType('Node')); // => true
* isInterfaceType(schema.getType('User')); // => false
* ```
*/
export declare function isInterfaceType(type: unknown): type is GraphQLInterfaceType;
/**
* Returns the value as a GraphQLInterfaceType, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLInterfaceType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
*
* const nodeType = assertInterfaceType(schema.getType('Node'));
*
* nodeType.name; // => 'Node'
* assertInterfaceType(schema.getType('User')); // throws an error
* ```
*/
export declare function assertInterfaceType(type: unknown): GraphQLInterfaceType;
/**
* Returns true when the value is a GraphQLUnionType.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLUnionType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isUnionType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Photo {
* url: String!
* }
*
* type Video {
* url: String!
* }
*
* union Media = Photo | Video
*
* type Query {
* media: [Media]
* }
* `);
*
* isUnionType(schema.getType('Media')); // => true
* isUnionType(schema.getType('Photo')); // => false
* ```
*/
export declare function isUnionType(type: unknown): type is GraphQLUnionType;
/**
* Returns the value as a GraphQLUnionType, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLUnionType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertUnionType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Photo {
* url: String!
* }
*
* type Video {
* url: String!
* }
*
* union Media = Photo | Video
*
* type Query {
* media: [Media]
* }
* `);
*
* const mediaType = assertUnionType(schema.getType('Media'));
*
* mediaType.getTypes().map((type) => type.name); // => ['Photo', 'Video']
* assertUnionType(schema.getType('Photo')); // throws an error
* ```
*/
export declare function assertUnionType(type: unknown): GraphQLUnionType;
/**
* Returns true when the value is a GraphQLEnumType.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLEnumType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isEnumType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* EMPIRE
* }
*
* type Query {
* favoriteEpisode: Episode
* }
* `);
*
* isEnumType(schema.getType('Episode')); // => true
* isEnumType(schema.getType('Query')); // => false
* ```
*/
export declare function isEnumType(type: unknown): type is GraphQLEnumType;
/**
* Returns the value as a GraphQLEnumType, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLEnumType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertEnumType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* EMPIRE
* }
*
* type Query {
* favoriteEpisode: Episode
* }
* `);
*
* const episodeType = assertEnumType(schema.getType('Episode'));
*
* episodeType.getValues().map((value) => value.name); // => ['NEW_HOPE', 'EMPIRE']
* assertEnumType(schema.getType('Query')); // throws an error
* ```
*/
export declare function assertEnumType(type: unknown): GraphQLEnumType;
/**
* Returns true when the value is a resolved GraphQL enum value definition.
* @param value - Value to inspect.
* @returns True when the value is a GraphQLEnumValue.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertEnumType, isEnumValue } from 'graphql/type';
*
* const schema = buildSchema(
* 'enum Episode { NEW_HOPE } type Query { episode: Episode }',
* );
* const enumValue = assertEnumType(schema.getType('Episode')).getValues()[0];
*
* isEnumValue(enumValue); // => true
* isEnumValue(schema.getType('Episode')); // => false
* ```
*/
export declare function isEnumValue(value: unknown): value is GraphQLEnumValue;
/**
* Returns the value as a GraphQLEnumValue, or throws if it is not one.
* @param value - Value to inspect.
* @returns The value typed as a GraphQLEnumValue.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertEnumType, assertEnumValue } from 'graphql/type';
*
* const schema = buildSchema(
* 'enum Episode { NEW_HOPE } type Query { episode: Episode }',
* );
* const enumValue = assertEnumValue(
* assertEnumType(schema.getType('Episode')).getValues()[0],
* );
*
* enumValue.name; // => 'NEW_HOPE'
* assertEnumValue(schema.getType('Episode')); // throws an error
* ```
*/
export declare function assertEnumValue(value: unknown): GraphQLEnumValue;
/**
* Returns true when the value is a GraphQLInputObjectType.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLInputObjectType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isInputObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput): Review
* }
* `);
*
* isInputObjectType(schema.getType('ReviewInput')); // => true
* isInputObjectType(schema.getType('Review')); // => false
* ```
*/
export declare function isInputObjectType(type: unknown): type is GraphQLInputObjectType;
/**
* Returns the value as a GraphQLInputObjectType, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLInputObjectType.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInputObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput): Review
* }
* `);
*
* const inputType = assertInputObjectType(schema.getType('ReviewInput'));
*
* Object.keys(inputType.getFields()); // => ['stars']
* assertInputObjectType(schema.getType('Review')); // throws an error
* ```
*/
export declare function assertInputObjectType(type: unknown): GraphQLInputObjectType;
/**
* Returns true when the value is a resolved GraphQL input field definition.
* @param field - Value to inspect.
* @returns True when the value is a GraphQLInputField.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInputObjectType, isInputField } from 'graphql/type';
*
* const schema = buildSchema(
* 'input ReviewInput { stars: Int } type Query { ok: Boolean }',
* );
* const inputField = assertInputObjectType(
* schema.getType('ReviewInput'),
* ).getFields().stars;
*
* isInputField(inputField); // => true
* isInputField(schema.getQueryType()); // => false
* ```
*/
export declare function isInputField(field: unknown): field is GraphQLInputField;
/**
* Returns the value as a GraphQLInputField, or throws if it is not one.
* @param field - Value to inspect.
* @returns The value typed as a GraphQLInputField.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInputField, assertInputObjectType } from 'graphql/type';
*
* const schema = buildSchema(
* 'input ReviewInput { stars: Int } type Query { ok: Boolean }',
* );
* const inputField = assertInputField(
* assertInputObjectType(schema.getType('ReviewInput')).getFields().stars,
* );
*
* inputField.name; // => 'stars'
* assertInputField(schema.getQueryType()); // throws an error
* ```
*/
export declare function assertInputField(field: unknown): GraphQLInputField;
/**
* Returns true when the value is a GraphQLList.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLList.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { GraphQLList, GraphQLString, isListType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* tags: [String!]!
* }
* `);
*
* const tagsField = schema.getQueryType()?.getFields().tags;
*
* isListType(new GraphQLList(GraphQLString)); // => true
* isListType(GraphQLString); // => false
* isListType(tagsField?.type); // => false
* ```
*/
export declare function isListType(type: GraphQLInputType): type is GraphQLList<GraphQLInputType>;
/**
* Returns true when the output type is a GraphQLList.
* @param type - The GraphQL output type to inspect.
* @returns True when the output type is a list type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { getNullableType, isListType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* tags: [String!]!
* }
* `);
*
* const tagsField = schema.getQueryType()?.getFields().tags;
* const nullableTagsType = getNullableType(tagsField?.type);
*
* isListType(nullableTagsType); // => true
* ```
*/
export declare function isListType(type: GraphQLOutputType): type is GraphQLList<GraphQLOutputType>;
/**
* Returns true when the value is a GraphQLList.
* @param type - The value to inspect.
* @returns True when the value is a list type.
* @example
* ```ts
* import { isListType } from 'graphql/type';
*
* isListType('[String]'); // => false
* isListType(null); // => false
* ```
*/
export declare function isListType(type: unknown): type is GraphQLList<GraphQLType>;
/**
* Returns the value as a GraphQLList, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLList.
* @example
* ```ts
* import { GraphQLList, GraphQLString, assertListType } from 'graphql/type';
*
* const listType = assertListType(new GraphQLList(GraphQLString));
*
* listType.ofType; // => GraphQLString
* assertListType(GraphQLString); // throws an error
* ```
*/
export declare function assertListType(type: unknown): GraphQLList<GraphQLType>;
/**
* Returns true when the value is a GraphQLNonNull.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQLNonNull.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { GraphQLNonNull, GraphQLString, isNonNullType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* name: String!
* nickname: String
* }
* `);
*
* const fields = schema.getQueryType()?.getFields();
*
* isNonNullType(new GraphQLNonNull(GraphQLString)); // => true
* isNonNullType(fields?.name.type); // => true
* isNonNullType(fields?.nickname.type); // => false
* ```
*/
export declare function isNonNullType(type: GraphQLInputType): type is GraphQLNonNull<GraphQLNullableInputType>;
/**
* Returns true when the output type is a GraphQLNonNull.
* @param type - The GraphQL output type to inspect.
* @returns True when the output type is a non-null type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isNonNullType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* name: String!
* nickname: String
* }
* `);
*
* const fields = schema.getQueryType()?.getFields();
*
* isNonNullType(fields?.name.type); // => true
* isNonNullType(fields?.nickname.type); // => false
* ```
*/
export declare function isNonNullType(type: GraphQLOutputType): type is GraphQLNonNull<GraphQLNullableOutputType>;
/**
* Returns true when the value is a GraphQLNonNull.
* @param type - The value to inspect.
* @returns True when the value is a non-null type.
* @example
* ```ts
* import { isNonNullType } from 'graphql/type';
*
* isNonNullType('String!'); // => false
* isNonNullType(null); // => false
* ```
*/
export declare function isNonNullType(type: unknown): type is GraphQLNonNull<GraphQLNullableType>;
/**
* Returns the value as a GraphQLNonNull, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQLNonNull.
* @example
* ```ts
* import { GraphQLNonNull, GraphQLString, assertNonNullType } from 'graphql/type';
*
* const nonNullType = assertNonNullType(new GraphQLNonNull(GraphQLString));
*
* nonNullType.ofType; // => GraphQLString
* assertNonNullType(GraphQLString); // throws an error
* ```
*/
export declare function assertNonNullType(type: unknown): GraphQLNonNull<GraphQLNullableType>;
/** These types may be used as input types for arguments and directives. */
export type GraphQLNullableInputType = GraphQLNamedInputType | GraphQLList<GraphQLInputType>;
/** These types may be used as input types for arguments and directives. */
export type GraphQLInputType = GraphQLNullableInputType | GraphQLNonNull<GraphQLNullableInputType>;
/**
* Returns true when the value can be used as a GraphQL input type.
* @param type - The GraphQL type to inspect.
* @returns True when the value can be used as a GraphQL input type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isInputType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput): Review
* }
* `);
*
* isInputType(schema.getType('ReviewInput')); // => true
* isInputType(schema.getType('Review')); // => false
* ```
*/
export declare function isInputType(type: unknown): type is GraphQLInputType;
/**
* Returns the value as a GraphQL input type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL input type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInputType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput): Review
* }
* `);
*
* const inputType = assertInputType(schema.getType('ReviewInput'));
*
* inputType.toString(); // => 'ReviewInput'
* assertInputType(schema.getType('Review')); // throws an error
* ```
*/
export declare function assertInputType(type: unknown): GraphQLInputType;
/** These types may be used as output types as the result of fields. */
export type GraphQLNullableOutputType = GraphQLNamedOutputType | GraphQLList<GraphQLOutputType>;
/** These types may be used as output types as the result of fields. */
export type GraphQLOutputType = GraphQLNullableOutputType | GraphQLNonNull<GraphQLNullableOutputType>;
/**
* Returns true when the value can be used as a GraphQL output type.
* @param type - The GraphQL type to inspect.
* @returns True when the value can be used as a GraphQL output type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isOutputType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput): Review
* }
* `);
*
* isOutputType(schema.getType('Review')); // => true
* isOutputType(schema.getType('ReviewInput')); // => false
* ```
*/
export declare function isOutputType(type: unknown): type is GraphQLOutputType;
/**
* Returns the value as a GraphQL output type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL output type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertOutputType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* review(input: ReviewInput): Review
* }
* `);
*
* const outputType = assertOutputType(schema.getType('Review'));
*
* outputType.toString(); // => 'Review'
* assertOutputType(schema.getType('ReviewInput')); // throws an error
* ```
*/
export declare function assertOutputType(type: unknown): GraphQLOutputType;
/** These types may describe types which may be leaf values. */
export type GraphQLLeafType = GraphQLScalarType | GraphQLEnumType;
/**
* Returns true when the value is a GraphQL scalar or enum type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQL scalar or enum type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isLeafType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* episode: Episode
* review: Review
* }
* `);
*
* isLeafType(schema.getType('Episode')); // => true
* isLeafType(schema.getType('String')); // => true
* isLeafType(schema.getType('Review')); // => false
* ```
*/
export declare function isLeafType(type: unknown): type is GraphQLLeafType;
/**
* Returns the value as a GraphQL leaf type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL leaf type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertLeafType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* }
*
* type Review {
* stars: Int!
* }
*
* type Query {
* episode: Episode
* review: Review
* }
* `);
*
* const episodeType = assertLeafType(schema.getType('Episode'));
*
* episodeType.toString(); // => 'Episode'
* assertLeafType(schema.getType('Review')); // throws an error
* ```
*/
export declare function assertLeafType(type: unknown): GraphQLLeafType;
/** These types may describe the parent context of a selection set. */
export type GraphQLCompositeType = GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType;
/**
* Returns true when the value is a GraphQL object, interface, or union type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQL object, interface, or union type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isCompositeType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* union SearchResult = User
*
* type Query {
* node: Node
* search: [SearchResult]
* }
* `);
*
* isCompositeType(schema.getType('User')); // => true
* isCompositeType(schema.getType('Node')); // => true
* isCompositeType(schema.getType('SearchResult')); // => true
* isCompositeType(schema.getType('String')); // => false
* ```
*/
export declare function isCompositeType(type: unknown): type is GraphQLCompositeType;
/**
* Returns the value as a GraphQL composite type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL composite type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertCompositeType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
*
* const userType = assertCompositeType(schema.getType('User'));
*
* userType.toString(); // => 'User'
* assertCompositeType(schema.getType('String')); // throws an error
* ```
*/
export declare function assertCompositeType(type: unknown): GraphQLCompositeType;
/** These types may describe the parent context of a selection set. */
export type GraphQLAbstractType = GraphQLInterfaceType | GraphQLUnionType;
/**
* Returns true when the value is a GraphQL interface or union type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQL interface or union type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { isAbstractType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* union SearchResult = User
*
* type Query {
* node: Node
* search: [SearchResult]
* }
* `);
*
* isAbstractType(schema.getType('Node')); // => true
* isAbstractType(schema.getType('SearchResult')); // => true
* isAbstractType(schema.getType('User')); // => false
* ```
*/
export declare function isAbstractType(type: unknown): type is GraphQLAbstractType;
/**
* Returns the value as a GraphQL abstract type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL abstract type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertAbstractType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
*
* const nodeType = assertAbstractType(schema.getType('Node'));
*
* nodeType.toString(); // => 'Node'
* assertAbstractType(schema.getType('User')); // throws an error
* ```
*/
export declare function assertAbstractType(type: unknown): GraphQLAbstractType;
/**
* List Type Wrapper
*
* A list is a wrapping type which points to another type.
* Lists are often created within the context of defining the fields of
* an object type.
* @typeParam T - The GraphQL type wrapped by this list type.
* @example
* ```ts
* const PersonType = new GraphQLObjectType({
* name: 'Person',
* fields: () => ({
* parents: { type: new GraphQLList(PersonType) },
* children: { type: new GraphQLList(PersonType) },
* }),
* });
* ```
*/
export declare class GraphQLList<T extends GraphQLType> implements GraphQLSchemaElement {
/** The type wrapped by this list or non-null type. */
readonly ofType: T;
private readonly __GraphQLListTypeBrand;
/**
* Creates a GraphQLList instance.
* @param ofType - The type to wrap.
* @example
* ```ts
* import { GraphQLList, GraphQLString } from 'graphql/type';
*
* const stringList = new GraphQLList(GraphQLString);
*
* stringList.ofType; // => GraphQLString
* String(stringList); // => '[String]'
* ```
*/
constructor(ofType: T);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns this wrapping type as a GraphQL type-reference string.
* @returns The GraphQL type-reference string.
* @example
* ```ts
* import { GraphQLList, GraphQLNonNull, GraphQLString } from 'graphql/type';
*
* const stringList = new GraphQLList(GraphQLString);
* const requiredStringList = new GraphQLList(new GraphQLNonNull(GraphQLString));
*
* stringList.toString(); // => '[String]'
* requiredStringList.toString(); // => '[String!]'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLList, GraphQLString } from 'graphql/type';
*
* const stringList = new GraphQLList(GraphQLString);
*
* stringList.toJSON(); // => '[String]'
* JSON.stringify({ type: stringList }); // => '{"type":"[String]"}'
* ```
*/
toJSON(): string;
}
/**
* Non-Null Type Wrapper
*
* A non-null is a wrapping type which points to another type.
* Non-null types enforce that their values are never null and can ensure
* an error is raised if this ever occurs during a request. It is useful for
* fields which you can make a strong guarantee on non-nullability, for example
* usually the id field of a database row will never be null.
* @typeParam T - The nullable GraphQL type wrapped by this non-null type.
* @example
* ```ts
* const RowType = new GraphQLObjectType({
* name: 'Row',
* fields: () => ({
* id: { type: new GraphQLNonNull(GraphQLString) },
* }),
* });
* ```
*
* Note: the enforcement of non-nullability occurs within the executor.
*/
export declare class GraphQLNonNull<T extends GraphQLNullableType> implements GraphQLSchemaElement {
/** The type wrapped by this list or non-null type. */
readonly ofType: T;
private readonly __GraphQLNonNullTypeBrand;
/**
* Creates a GraphQLNonNull instance.
* @param ofType - The type to wrap.
* @example
* ```ts
* import { GraphQLNonNull, GraphQLString } from 'graphql/type';
*
* const requiredString = new GraphQLNonNull(GraphQLString);
*
* requiredString.ofType; // => GraphQLString
* String(requiredString); // => 'String!'
* ```
*/
constructor(ofType: T);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns this wrapping type as a GraphQL type-reference string.
* @returns The GraphQL type-reference string.
* @example
* ```ts
* import { GraphQLList, GraphQLNonNull, GraphQLString } from 'graphql/type';
*
* const requiredString = new GraphQLNonNull(GraphQLString);
* const requiredStringList = new GraphQLNonNull(new GraphQLList(GraphQLString));
*
* requiredString.toString(); // => 'String!'
* requiredStringList.toString(); // => '[String]!'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLNonNull, GraphQLString } from 'graphql/type';
*
* const requiredString = new GraphQLNonNull(GraphQLString);
*
* requiredString.toJSON(); // => 'String!'
* JSON.stringify({ type: requiredString }); // => '{"type":"String!"}'
* ```
*/
toJSON(): string;
}
/** These types wrap and modify other types */
export type GraphQLWrappingType = GraphQLList<GraphQLType> | GraphQLNonNull<GraphQLNullableType>;
/**
* Returns true when the value is a GraphQL list or non-null wrapper type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQL list or non-null wrapper type.
* @example
* ```ts
* import {
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* isWrappingType,
* } from 'graphql/type';
*
* isWrappingType(new GraphQLList(GraphQLString)); // => true
* isWrappingType(new GraphQLNonNull(GraphQLString)); // => true
* isWrappingType(GraphQLString); // => false
* ```
*/
export declare function isWrappingType(type: unknown): type is GraphQLWrappingType;
/**
* Returns the value as a GraphQL wrapping type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL wrapping type.
* @example
* ```ts
* import { GraphQLList, GraphQLString, assertWrappingType } from 'graphql/type';
*
* const wrappingType = assertWrappingType(new GraphQLList(GraphQLString));
*
* wrappingType.toString(); // => '[String]'
* assertWrappingType(GraphQLString); // throws an error
* ```
*/
export declare function assertWrappingType(type: unknown): GraphQLWrappingType;
/** These types can all accept null as a value. */
export type GraphQLNullableType = GraphQLNamedType | GraphQLList<GraphQLType>;
/**
* Returns true when the value is a GraphQL type that can accept null.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQL type that can accept null.
* @example
* ```ts
* import { GraphQLNonNull, GraphQLString, isNullableType } from 'graphql/type';
*
* isNullableType(GraphQLString); // => true
* isNullableType(new GraphQLNonNull(GraphQLString)); // => false
* isNullableType(null); // => false
* ```
*/
export declare function isNullableType(type: unknown): type is GraphQLNullableType;
/**
* Returns the value as a nullable GraphQL type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a nullable GraphQL type.
* @example
* ```ts
* import {
* GraphQLNonNull,
* GraphQLString,
* assertNullableType,
* } from 'graphql/type';
*
* const nullableType = assertNullableType(GraphQLString);
*
* nullableType; // => GraphQLString
* assertNullableType(new GraphQLNonNull(GraphQLString)); // throws an error
* ```
*/
export declare function assertNullableType(type: unknown): GraphQLNullableType;
/**
* Returns the nullable type.
* @param type - The GraphQL type to inspect.
* @returns The nullable type after removing one non-null wrapper, if present.
* @example
* ```ts
* import { getNullableType } from 'graphql/type';
*
* getNullableType(null); // => undefined
* getNullableType(undefined); // => undefined
* ```
*/
export declare function getNullableType(type: undefined | null): void;
/**
* Returns the nullable type after removing one non-null wrapper.
* @param type - A nullable type or non-null wrapper.
* @returns The nullable type after removing one non-null wrapper, if present.
* @typeParam T - The nullable GraphQL type returned after removing one non-null wrapper.
* @example
* ```ts
* import {
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* getNullableType,
* } from 'graphql/type';
*
* const requiredString = new GraphQLNonNull(GraphQLString);
* const stringList = new GraphQLList(GraphQLString);
*
* getNullableType(requiredString); // => GraphQLString
* getNullableType(stringList); // => stringList
* ```
*/
export declare function getNullableType<T extends GraphQLNullableType>(type: T | GraphQLNonNull<T>): T;
/**
* Returns the nullable type after removing one non-null wrapper.
* @param type - The GraphQL type to inspect.
* @returns The nullable type after removing one non-null wrapper, if present.
* @example
* ```ts
* import {
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* getNullableType,
* } from 'graphql/type';
*
* const requiredStringList = new GraphQLNonNull(new GraphQLList(GraphQLString));
*
* getNullableType(requiredStringList).toString(); // => '[String]'
* getNullableType(GraphQLString); // => GraphQLString
* ```
*/
export declare function getNullableType(type: Maybe<GraphQLType>): GraphQLNullableType | undefined;
/** These named types do not include modifiers like List or NonNull. */
export type GraphQLNamedType = GraphQLNamedInputType | GraphQLNamedOutputType;
/** A named GraphQL type that can be used as an input type. */
export type GraphQLNamedInputType = GraphQLScalarType | GraphQLEnumType | GraphQLInputObjectType;
/** A named GraphQL type that can be used as an output type. */
export type GraphQLNamedOutputType = GraphQLScalarType | GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType | GraphQLEnumType;
/**
* Returns true when the value is a GraphQL named type.
* @param type - The GraphQL type to inspect.
* @returns True when the value is a GraphQL named type.
* @example
* ```ts
* import { GraphQLList, GraphQLString, isNamedType } from 'graphql/type';
*
* isNamedType(GraphQLString); // => true
* isNamedType(new GraphQLList(GraphQLString)); // => false
* isNamedType(null); // => false
* ```
*/
export declare function isNamedType(type: unknown): type is GraphQLNamedType;
/**
* Returns the value as a GraphQL named type, or throws if it is not one.
* @param type - The GraphQL type to inspect.
* @returns The value typed as a GraphQL named type.
* @example
* ```ts
* import { GraphQLList, GraphQLString, assertNamedType } from 'graphql/type';
*
* const namedType = assertNamedType(GraphQLString);
*
* namedType.name; // => 'String'
* assertNamedType(new GraphQLList(GraphQLString)); // throws an error
* ```
*/
export declare function assertNamedType(type: unknown): GraphQLNamedType;
/**
* Returns the named type.
* @param type - The GraphQL type to inspect.
* @returns The named type after unwrapping all list and non-null wrappers.
* @example
* ```ts
* import { getNamedType } from 'graphql/type';
*
* getNamedType(null); // => undefined
* getNamedType(undefined); // => undefined
* ```
*/
export declare function getNamedType(type: undefined | null): void;
/**
* Returns the named input type after unwrapping all list and non-null wrappers.
* @param type - The GraphQL input type to inspect.
* @returns The named input type after unwrapping all wrappers.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { getNamedType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Query {
* review(input: [ReviewInput!]!): Boolean
* }
* `);
*
* const inputArg = schema.getQueryType()?.getFields().review.args[0];
*
* getNamedType(inputArg?.type).toString(); // => 'ReviewInput'
* ```
*/
export declare function getNamedType(type: GraphQLInputType): GraphQLNamedInputType;
/**
* Returns the named output type after unwrapping all list and non-null wrappers.
* @param type - The GraphQL output type to inspect.
* @returns The named output type after unwrapping all wrappers.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { getNamedType } from 'graphql/type';
*
* const schema = buildSchema(`
* type User {
* name: String
* }
*
* type Query {
* users: [User!]!
* }
* `);
*
* const usersField = schema.getQueryType()?.getFields().users;
*
* getNamedType(usersField?.type).toString(); // => 'User'
* ```
*/
export declare function getNamedType(type: GraphQLOutputType): GraphQLNamedOutputType;
/**
* Returns the named type after unwrapping all list and non-null wrappers.
* @param type - The GraphQL type to inspect.
* @returns The named type after unwrapping all wrappers.
* @example
* ```ts
* import {
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* getNamedType,
* } from 'graphql/type';
*
* const nestedType = new GraphQLNonNull(
* new GraphQLList(new GraphQLNonNull(GraphQLString)),
* );
*
* getNamedType(nestedType); // => GraphQLString
* ```
*/
export declare function getNamedType(type: GraphQLType): GraphQLNamedType;
/**
* Returns the named type after unwrapping all list and non-null wrappers.
* @param type - The GraphQL type to inspect.
* @returns The named type after unwrapping all wrappers, or undefined for nullish input.
* @example
* ```ts
* import { GraphQLList, GraphQLString, getNamedType } from 'graphql/type';
*
* getNamedType(new GraphQLList(GraphQLString)); // => GraphQLString
* getNamedType(undefined); // => undefined
* ```
*/
export declare function getNamedType(type: Maybe<GraphQLType>): GraphQLNamedType | undefined;
interface GraphQLSchemaElement {
toString: () => string;
toJSON: () => string;
}
/**
* Used while defining GraphQL types to allow for circular references in
* otherwise immutable type definitions.
* @typeParam T - The element type returned by the thunk or array.
*/
export type ThunkReadonlyArray<T> = (() => ReadonlyArray<T>) | ReadonlyArray<T>;
/**
* A thunk that resolves to an object map.
* @typeParam T - Value type stored in the object map.
*/
export type ThunkObjMap<T> = (() => ObjMap<T>) | ObjMap<T>;
/**
* Resolves a thunked readonly array.
* @param thunk - The thunk or value to resolve.
* @returns The resolved readonly array.
* @typeParam T - The element type resolved from the thunk or array.
* @example
* ```ts
* import { GraphQLString, resolveReadonlyArrayThunk } from 'graphql/type';
*
* const lazyFields = resolveReadonlyArrayThunk(() => [GraphQLString]);
* const fields = resolveReadonlyArrayThunk([GraphQLString]);
*
* lazyFields; // => [GraphQLString]
* fields; // => [GraphQLString]
* ```
*/
export declare function resolveReadonlyArrayThunk<T>(thunk: ThunkReadonlyArray<T>): ReadonlyArray<T>;
/**
* Resolves a thunked object map.
* @param thunk - The thunk or value to resolve.
* @returns The resolved object map.
* @typeParam T - The object-map value type resolved from the thunk or map.
* @example
* ```ts
* import { GraphQLString, resolveObjMapThunk } from 'graphql/type';
*
* const lazyFields = resolveObjMapThunk(() => ({ name: GraphQLString }));
* const fields = resolveObjMapThunk({ name: GraphQLString });
*
* lazyFields.name; // => GraphQLString
* fields.name; // => GraphQLString
* ```
*/
export declare function resolveObjMapThunk<T>(thunk: ThunkObjMap<T>): ObjMap<T>;
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLScalarTypeExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Scalar Type Definition
*
* Scalar types define the leaf values of a GraphQL response and the input
* values accepted by arguments and input object fields. A scalar type has a
* name and coercion functions that validate and convert runtime values and
* GraphQL literals.
*
* If a type's coerceOutputValue function returns `null` or does not return a
* value (i.e. it returns `undefined`) then an error will be raised and a
* `null` value will be returned in the response. Prefer validating inputs
* before execution so clients receive input diagnostics before result coercion
* fails.
* Custom scalar behavior is defined via the following functions:
*
* - coerceOutputValue(value): Implements "Result Coercion". Given an internal value,
* produces an external value valid for this type. Returns undefined or
* throws an error to indicate invalid values.
*
* - coerceInputValue(value): Implements "Input Coercion" for values. Given an
* external value (for example, variable values), produces an internal value
* valid for this type. Returns undefined or throws an error to indicate
* invalid values.
*
* - coerceInputLiteral(ast): Implements "Input Coercion" for constant literals.
* Given a GraphQL literal (AST) (for example, an argument value), produces
* an internal value valid for this type. Returns undefined or throws an
* error to indicate invalid values.
*
* - valueToLiteral(value): Converts an external value to a GraphQL
* literal (AST). Returns undefined or throws an error to indicate
* invalid values.
*
* Deprecated, to be removed in v18:
*
* - serialize(value): Implements "Result Coercion". Renamed to
* `coerceOutputValue()`.
*
* - parseValue(value): Implements "Input Coercion" for values. Renamed to
* `coerceInputValue()`.
*
* - parseLiteral(ast): Implements "Input Coercion" for literals including
* non-specified replacement of variables embedded within complex scalars.
* Replaced by the combination of the `replaceVariables()` utility and the
* `coerceInputLiteral()` method.
* @typeParam TInternal - Internal runtime representation for this scalar.
* @typeParam TExternal - External representation accepted from or returned to callers.
* @example
* ```ts
* import { GraphQLScalarType, Kind } from 'graphql';
*
* const ensureOdd = (value) => {
* if (!Number.isFinite(value)) {
* throw new Error(
* `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
* );
* }
*
* if (value % 2 === 0) {
* throw new Error(
* `Scalar "Odd" cannot represent "${value}" since it is even.`,
* );
* }
*
* return value;
* };
*
* const OddType = new GraphQLScalarType({
* name: 'Odd',
* coerceOutputValue: (value) => {
* return ensureOdd(value);
* },
* coerceInputValue: (value) => {
* return ensureOdd(value);
* },
* valueToLiteral: (value) => {
* return { kind: Kind.INT, value: String(ensureOdd(value)) };
* },
* });
* ```
*/
export declare class GraphQLScalarType<TInternal = unknown, TExternal = TInternal> implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** URL identifying the behavior specified for this custom scalar. */
specifiedByURL: Maybe<string>;
/**
* Deprecated legacy serializer used to convert internal values for response
* output. Use `coerceOutputValue()` instead.
* @deprecated use `coerceOutputValue()` instead, `serialize()` will be removed in v18
*/
serialize: GraphQLScalarSerializer<TExternal>;
/**
* Deprecated legacy parser used to convert externally provided input values.
* Use `coerceInputValue()` instead.
* @deprecated use `coerceInputValue()` instead, `parseValue()` will be removed in v18
*/
parseValue: GraphQLScalarValueParser<TInternal>;
/**
* Deprecated legacy parser used to convert externally provided input
* literals. Use `replaceVariables()` and `coerceInputLiteral()` instead.
* @deprecated use `replaceVariables()` and `coerceInputLiteral()` instead, `parseLiteral()` will be removed in v18
*/
parseLiteral: GraphQLScalarLiteralParser<TInternal>;
/** Coercer used to convert internal scalar values for response output. */
coerceOutputValue: GraphQLScalarOutputValueCoercer<TExternal>;
/** Coercer used to convert externally provided scalar input values. */
coerceInputValue: GraphQLScalarInputValueCoercer<TInternal>;
/** Coercer used to convert GraphQL scalar input literals. */
coerceInputLiteral: GraphQLScalarInputLiteralCoercer<TInternal> | undefined;
/** Converter used to produce GraphQL literals from runtime input values. */
valueToLiteral: GraphQLScalarValueToLiteral | undefined;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLScalarTypeExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<ScalarTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<ScalarTypeExtensionNode>;
/**
* Creates a GraphQLScalarType instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* import { Kind, parse } from 'graphql/language';
* import { GraphQLScalarType } from 'graphql/type';
*
* const document = parse(`
* "Odd integer values."
* scalar Odd @specifiedBy(url: "https://example.com/odd")
*
* extend scalar Odd @specifiedBy(url: "https://example.com/odd-v2")
* `);
*
* const Odd = new GraphQLScalarType({
* name: 'Odd',
* description: 'Odd integer values.',
* specifiedByURL: 'https://example.com/odd',
* coerceOutputValue: (value) => {
* if (typeof value !== 'number' || value % 2 === 0) {
* throw new TypeError('Odd can only produce odd numbers.');
* }
* return value;
* },
* coerceInputValue: (value) => {
* if (typeof value !== 'number' || value % 2 === 0) {
* throw new TypeError('Odd can only accept odd numbers.');
* }
* return value;
* },
* coerceInputLiteral: (ast) => {
* if (ast.kind !== Kind.INT) {
* throw new TypeError('Odd can only accept integer literals.');
* }
* const value = Number(ast.value);
* if (value % 2 === 0) {
* throw new TypeError('Odd can only accept odd integer literals.');
* }
* return value;
* },
* valueToLiteral: (value) => {
* return { kind: Kind.INT, value: String(ensureOdd(value)) };
* },
* extensions: { numeric: true },
* astNode: document.definitions[0],
* extensionASTNodes: [document.definitions[1]],
* });
*
* Odd.description; // => 'Odd integer values.'
* Odd.specifiedByURL; // => 'https://example.com/odd'
* Odd.coerceOutputValue(3); // => 3
* Odd.coerceInputValue(5); // => 5
* Odd.extensions; // => { numeric: true }
* ```
*/
constructor(config: Readonly<GraphQLScalarTypeConfig<TInternal, TExternal>>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import { GraphQLScalarType } from 'graphql/type';
*
* const Url = new GraphQLScalarType({
* name: 'Url',
* description: 'An absolute URL string.',
* specifiedByURL: 'https://url.spec.whatwg.org/',
* });
*
* const config = Url.toConfig();
* const UrlCopy = new GraphQLScalarType(config);
*
* config.name; // => 'Url'
* config.specifiedByURL; // => 'https://url.spec.whatwg.org/'
* UrlCopy.name; // => Url.name
* ```
*/
toConfig(): GraphQLScalarTypeNormalizedConfig<TInternal, TExternal>;
/**
* Returns the schema coordinate identifying this scalar type.
* @returns The schema coordinate for this scalar type.
* @example
* ```ts
* import { GraphQLScalarType } from 'graphql/type';
*
* const DateTime = new GraphQLScalarType({ name: 'DateTime' });
*
* DateTime.toString(); // => 'DateTime'
* String(DateTime); // => 'DateTime'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLScalarType } from 'graphql/type';
*
* const DateTime = new GraphQLScalarType({ name: 'DateTime' });
*
* DateTime.toJSON(); // => 'DateTime'
* JSON.stringify({ type: DateTime }); // => '{"type":"DateTime"}'
* ```
*/
toJSON(): string;
}
/**
* Deprecated function type that serializes a runtime value as a scalar output
* value. Use `GraphQLScalarOutputValueCoercer` instead.
* @typeParam TExternal - External representation accepted from or returned to callers.
* @deprecated Use GraphQLScalarOutputValueCoercer instead. Will be removed in v18.
*/
export type GraphQLScalarSerializer<TExternal> = (outputValue: unknown) => TExternal;
/**
* Function used to coerce internal scalar values for response output.
* @typeParam TExternal - External representation accepted from or returned to callers.
*/
export type GraphQLScalarOutputValueCoercer<TExternal> = (outputValue: unknown) => TExternal;
/**
* Deprecated function type that parses a runtime input value as a scalar input
* value. Use `GraphQLScalarInputValueCoercer` instead.
* @typeParam TInternal - Internal runtime representation for this scalar.
* @deprecated Use GraphQLScalarInputValueCoercer instead. Will be removed in v18.
*/
export type GraphQLScalarValueParser<TInternal> = (inputValue: unknown) => TInternal;
/**
* Function used to coerce externally provided scalar input values.
* @typeParam TInternal - Internal runtime representation for this scalar.
*/
export type GraphQLScalarInputValueCoercer<TInternal> = (inputValue: unknown) => TInternal;
/**
* Deprecated function type that parses a GraphQL value literal as a scalar
* input value. Use `GraphQLScalarInputLiteralCoercer` instead.
* @typeParam TInternal - Internal runtime representation for this scalar.
* @deprecated Use GraphQLScalarInputLiteralCoercer instead. Will be removed in v18.
*/
export type GraphQLScalarLiteralParser<TInternal> = (valueNode: ValueNode, variables: Maybe<ObjMap<unknown>>) => Maybe<TInternal>;
/**
* Function used to coerce GraphQL scalar input literals.
* @typeParam TInternal - Internal runtime representation for this scalar.
*/
export type GraphQLScalarInputLiteralCoercer<TInternal> = (valueNode: ConstValueNode) => Maybe<TInternal>;
type GraphQLScalarValueToLiteral = (inputValue: unknown) => ConstValueNode | undefined;
/**
* Configuration used to construct a GraphQLScalarType.
* @typeParam TInternal - Internal runtime representation for this scalar.
* @typeParam TExternal - External representation accepted from or returned to callers.
*/
export interface GraphQLScalarTypeConfig<TInternal, TExternal> {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** URL identifying the behavior specified for this custom scalar. */
specifiedByURL?: Maybe<string>;
/**
* Deprecated legacy serializer used to convert internal values for response
* output. Use `coerceOutputValue()` instead.
* @deprecated use `coerceOutputValue()` instead, `serialize()` will be removed in v18
*/
serialize?: GraphQLScalarSerializer<TExternal> | undefined;
/**
* Deprecated legacy parser used to convert externally provided input values.
* Use `coerceInputValue()` instead.
* @deprecated use `coerceInputValue()` instead, `parseValue()` will be removed in v18
*/
parseValue?: GraphQLScalarValueParser<TInternal> | undefined;
/**
* Deprecated legacy parser used to convert externally provided input
* literals. Use `replaceVariables()` and `coerceInputLiteral()` instead.
* @deprecated use `replaceVariables()` and `coerceInputLiteral()` instead, `parseLiteral()` will be removed in v18
*/
parseLiteral?: GraphQLScalarLiteralParser<TInternal> | undefined;
/** Coerces an internal value to include in a response. */
coerceOutputValue?: GraphQLScalarOutputValueCoercer<TExternal> | undefined;
/** Coerces an externally provided value to use as an input. */
coerceInputValue?: GraphQLScalarInputValueCoercer<TInternal> | undefined;
/** Coerces an externally provided const literal value to use as an input. */
coerceInputLiteral?: GraphQLScalarInputLiteralCoercer<TInternal> | undefined;
/** Translates an externally provided value to a literal (AST). */
valueToLiteral?: GraphQLScalarValueToLiteral | undefined;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLScalarTypeExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<ScalarTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<ScalarTypeExtensionNode>>;
}
interface GraphQLScalarTypeNormalizedConfig<TInternal, TExternal> extends GraphQLScalarTypeConfig<TInternal, TExternal> {
serialize: GraphQLScalarSerializer<TExternal>;
parseValue: GraphQLScalarValueParser<TInternal>;
parseLiteral: GraphQLScalarLiteralParser<TInternal>;
coerceOutputValue: GraphQLScalarOutputValueCoercer<TExternal>;
coerceInputValue: GraphQLScalarInputValueCoercer<TInternal>;
coerceInputLiteral: GraphQLScalarInputLiteralCoercer<TInternal> | undefined;
extensions: Readonly<GraphQLScalarTypeExtensions>;
extensionASTNodes: ReadonlyArray<ScalarTypeExtensionNode>;
}
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
* We've provided these template arguments because this is an open type and
* you may find them useful.
* @typeParam _TSource - Reserved source type parameter for extension typing.
* @typeParam _TContext - Reserved context type parameter for extension typing.
*/
export interface GraphQLObjectTypeExtensions<_TSource = any, _TContext = any> {
[attributeName: string | symbol]: unknown;
}
/**
* Object Type Definition
*
* Almost all of the GraphQL types you define will be object types. Object types
* have a name, but most importantly describe their fields.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @typeParam TAbstract - Runtime value type used for abstract type resolution.
* @example
* ```ts
* const AddressType = new GraphQLObjectType({
* name: 'Address',
* fields: {
* street: { type: GraphQLString },
* number: { type: GraphQLInt },
* formatted: {
* type: GraphQLString,
* resolve: (obj) => {
* return obj.number + ' ' + obj.street;
* },
* },
* },
* });
* ```
* @example
* When two types need to refer to each other, or a type needs to refer to
* itself in a field, you can use a function expression (aka a closure or a
* thunk) to supply the fields lazily.
*
* ```ts
* const PersonType = new GraphQLObjectType({
* name: 'Person',
* fields: () => ({
* name: { type: GraphQLString },
* bestFriend: { type: PersonType },
* }),
* });
* ```
*/
export declare class GraphQLObjectType<TSource = any, TContext = any, TAbstract = any> implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Predicate used to determine whether a runtime value belongs to this object type. */
isTypeOf: Maybe<GraphQLIsTypeOfFn<TAbstract, TContext>>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLObjectTypeExtensions<TSource, TContext>>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<ObjectTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<ObjectTypeExtensionNode>;
private _fields;
private _interfaces;
/**
* Creates a GraphQLObjectType instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* // Configure an object type with interfaces, fields, arguments, and metadata.
* import { parse } from 'graphql/language';
* import {
* GraphQLID,
* GraphQLInterfaceType,
* GraphQLNonNull,
* GraphQLObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const document = parse(`
* type User implements Node {
* id: ID!
* name(format: String = "short"): String
* }
*
* extend type User {
* displayName: String
* }
* `);
* const definition = document.definitions[0];
* const nameField = definition.fields[1];
* const formatArg = nameField.arguments[0];
*
* const Node = new GraphQLInterfaceType({
* name: 'Node',
* fields: {
* id: { type: new GraphQLNonNull(GraphQLID) },
* },
* });
*
* const User = new GraphQLObjectType({
* name: 'User',
* description: 'A registered user.',
* interfaces: [Node],
* fields: {
* id: { type: new GraphQLNonNull(GraphQLID) },
* name: {
* description: 'The formatted user name.',
* type: GraphQLString,
* args: {
* format: {
* description: 'Controls the name format.',
* type: GraphQLString,
* default: { value: 'short' },
* deprecationReason: 'Use locale instead.',
* extensions: { public: true },
* astNode: formatArg,
* },
* },
* resolve: (user, { format }) => {
* return format === 'long' ? user.fullName : user.name;
* },
* deprecationReason: 'Use displayName.',
* extensions: { cacheSeconds: 60 },
* astNode: nameField,
* },
* },
* isTypeOf: (value) => {
* return typeof value === 'object' && value != null && 'id' in value;
* },
* extensions: { entity: 'User' },
* astNode: definition,
* extensionASTNodes: [document.definitions[1]],
* });
*
* User.name; // => 'User'
* User.getInterfaces(); // => [Node]
* Object.keys(User.getFields()); // => ['id', 'name']
* User.getFields().name.args[0].default.value; // => 'short'
* User.extensions; // => { entity: 'User' }
* ```
* @example
* ```ts
* // This variant configures a subscription field with subscribe and resolve functions.
* import { GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const Subscription = new GraphQLObjectType({
* name: 'Subscription',
* fields: {
* greeting: {
* type: GraphQLString,
* subscribe: async function* () {
* yield { greeting: 'Hello!' };
* },
* resolve: (event) => {
* return event.greeting;
* },
* },
* },
* });
*
* typeof Subscription.getFields().greeting.subscribe; // => 'function'
* ```
*/
constructor(config: Readonly<GraphQLObjectTypeConfig<TSource, TContext, TAbstract>>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the fields defined by this type.
* @returns The fields keyed by field name.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* type User {
* id: ID!
* name: String
* }
*
* type Query {
* viewer: User
* }
* `);
*
* const User = assertObjectType(schema.getType('User'));
* const fields = User.getFields();
*
* Object.keys(fields); // => ['id', 'name']
* String(fields.id.type); // => 'ID!'
* ```
*/
getFields(): GraphQLFieldMap<TSource, TContext>;
/**
* Returns the interfaces implemented by this type.
* @returns The implemented interfaces.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* viewer: User
* }
* `);
*
* const User = assertObjectType(schema.getType('User'));
*
* User.getInterfaces().map((type) => type.name); // => ['Node']
* ```
*/
getInterfaces(): ReadonlyArray<GraphQLInterfaceType>;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import { GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const User = new GraphQLObjectType({
* name: 'User',
* fields: {
* name: { type: GraphQLString },
* },
* });
*
* const config = User.toConfig();
* const UserCopy = new GraphQLObjectType(config);
*
* config.fields.name.type; // => GraphQLString
* UserCopy.getFields().name.type; // => GraphQLString
* ```
*/
toConfig(): GraphQLObjectTypeNormalizedConfig<TSource, TContext, TAbstract>;
/**
* Returns the schema coordinate identifying this object type.
* @returns The schema coordinate for this object type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* type User {
* name: String
* }
*
* type Query {
* viewer: User
* }
* `);
*
* const User = assertObjectType(schema.getType('User'));
*
* User.toString(); // => 'User'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const User = new GraphQLObjectType({
* name: 'User',
* fields: { name: { type: GraphQLString } },
* });
*
* User.toJSON(); // => 'User'
* JSON.stringify({ type: User }); // => '{"type":"User"}'
* ```
*/
toJSON(): string;
}
/**
* Configuration used to construct a GraphQLObjectType.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @typeParam TAbstract - Runtime value type used for abstract type resolution.
*/
export interface GraphQLObjectTypeConfig<TSource, TContext, TAbstract = unknown> {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Interfaces implemented by this object or interface type. */
interfaces?: ThunkReadonlyArray<GraphQLInterfaceType> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
fields: ThunkObjMap<GraphQLFieldConfig<TSource, TContext>>;
/** Predicate used to determine whether a runtime value belongs to this object type. */
isTypeOf?: Maybe<GraphQLIsTypeOfFn<TAbstract, TContext>>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLObjectTypeExtensions<TSource, TContext>>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<ObjectTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<ObjectTypeExtensionNode>>;
}
interface GraphQLObjectTypeNormalizedConfig<TSource, TContext, TAbstract = unknown> extends GraphQLObjectTypeConfig<TSource, TContext, TAbstract> {
interfaces: ReadonlyArray<GraphQLInterfaceType>;
fields: GraphQLFieldNormalizedConfigMap<TSource, TContext>;
extensions: Readonly<GraphQLObjectTypeExtensions<TSource, TContext>>;
extensionASTNodes: ReadonlyArray<ObjectTypeExtensionNode>;
}
/**
* Resolves the concrete object type for an abstract GraphQL type.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
*/
export type GraphQLTypeResolver<TSource, TContext> = (value: TSource, context: TContext, info: GraphQLResolveInfo, abstractType: GraphQLAbstractType) => PromiseOrValue<string | undefined>;
/**
* Checks whether a runtime value belongs to a GraphQL object type.
* @typeParam TAbstract - Runtime value type used for abstract type resolution.
* @typeParam TContext - Context object type passed to resolvers.
*/
export type GraphQLIsTypeOfFn<TAbstract, TContext> = (value: TAbstract, context: TContext, info: GraphQLResolveInfo) => PromiseOrValue<boolean>;
/**
* Resolves the runtime value for a GraphQL field.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @typeParam TArgs - Argument object type passed to resolvers.
* @typeParam TResult - Result value type.
*/
export type GraphQLFieldResolver<TSource, TContext, TArgs = any, TResult = unknown> = (source: TSource, args: TArgs, context: TContext, info: GraphQLResolveInfo) => TResult;
/** Utilities available from resolver info for tracking asynchronous work. */
export interface GraphQLResolveInfoHelpers {
/**
* Promise.all wrapper that allows rejected branches to be tracked
* as execution async work.
*
* Intended use: return or await this promise from resolver work.
* Un-awaited async side effects are an anti-pattern:
*
* const { promiseAll } = info.getAsyncHelpers();
* promiseAll([someAsyncWork(), someOtherAsyncWork()]).catch(() => undefined);
*
* In that anti-pattern, tracking starts only after rejection (on a
* later microtask), so this work is not guaranteed to delay
* `hooks.asyncWorkFinished`.
*
* Use `track(...)` for un-awaited async side effects:
*
* const { track } = info.getAsyncHelpers();
* track([
* someAsyncWork().catch(() => undefined),
* someOtherAsyncWork().catch(() => undefined)
* ]);
*/
readonly promiseAll: <T>(values: ReadonlyArray<PromiseLike<T> | T>) => Promise<Array<T>>;
/** Tracks asynchronous work that should delay execution completion hooks. */
readonly track: (maybePromises: ReadonlyArray<unknown>) => void;
}
/** Information about the currently executing GraphQL field. */
export interface GraphQLResolveInfo {
/** The field name referenced by this schema coordinate. */
readonly fieldName: string;
/** AST field nodes that contributed to the current field execution. */
readonly fieldNodes: ReadonlyArray<FieldNode>;
/** GraphQL output type declared for the current field. */
readonly returnType: GraphQLOutputType;
/** Object type that owns the current field. */
readonly parentType: GraphQLObjectType;
/** Response path where this error occurred during execution. */
readonly path: Path;
/** The schema used for validation or execution. */
readonly schema: GraphQLSchema;
/** Fragment definitions in the operation document keyed by fragment name. */
readonly fragments: ObjMap<FragmentDefinitionNode>;
/** Initial root value passed to the operation. */
readonly rootValue: unknown;
/** The operation selected for execution. */
readonly operation: OperationDefinitionNode;
/**
* Coerced variable values and source metadata for this operation. Resolver
* code that needs runtime variable values should read `variableValues.coerced`.
*/
readonly variableValues: VariableValues;
/** Returns the AbortSignal supplied for this execution, if any. */
readonly getAbortSignal: () => AbortSignal | undefined;
/** Returns helper functions for tracking asynchronous resolver work. */
readonly getAsyncHelpers: () => GraphQLResolveInfoHelpers;
}
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
* We've provided these template arguments because this is an open type and
* you may find them useful.
* @typeParam _TSource - Reserved source type parameter for extension typing.
* @typeParam _TContext - Reserved context type parameter for extension typing.
* @typeParam _TArgs - Reserved argument type parameter for extension typing.
*/
export interface GraphQLFieldExtensions<_TSource, _TContext, _TArgs = any> {
[attributeName: string | symbol]: unknown;
}
/**
* Configuration used to define a GraphQL field.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @typeParam TArgs - Argument object type passed to resolvers.
*/
export interface GraphQLFieldConfig<TSource, TContext, TArgs = any> {
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
type: GraphQLOutputType;
/** Arguments accepted by this field or directive. */
args?: GraphQLFieldConfigArgumentMap | undefined;
/** Resolver function used to produce this field value. */
resolve?: GraphQLFieldResolver<TSource, TContext, TArgs> | undefined;
/** Resolver function used to create a subscription event stream for this field. */
subscribe?: GraphQLFieldResolver<TSource, TContext, TArgs> | undefined;
/** Reason this element is deprecated, if one was provided. */
deprecationReason?: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLFieldExtensions<TSource, TContext, TArgs>>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<FieldDefinitionNode>;
}
interface GraphQLFieldNormalizedConfig<TSource, TContext, TArgs = any> extends GraphQLFieldConfig<TSource, TContext, TArgs> {
args: GraphQLFieldNormalizedConfigArgumentMap;
extensions: Readonly<GraphQLFieldExtensions<TSource, TContext, TArgs>>;
}
/** A map of argument names to argument configuration objects. */
export type GraphQLFieldConfigArgumentMap = ObjMap<GraphQLArgumentConfig>;
type GraphQLFieldNormalizedConfigArgumentMap = ObjMap<GraphQLArgumentNormalizedConfig>;
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLArgumentExtensions {
[attributeName: string | symbol]: unknown;
}
/** Configuration used to define a GraphQL argument. */
export interface GraphQLArgumentConfig {
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
type: GraphQLInputType;
/**
* Deprecated legacy default value for this argument. Use `default` instead.
* @deprecated use `default` instead, `defaultValue` will be removed in v18
*/
defaultValue?: unknown;
/** Default value represented as either a runtime value or a GraphQL literal. */
default?: GraphQLDefaultInput | undefined;
/** Reason this element is deprecated, if one was provided. */
deprecationReason?: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLArgumentExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<InputValueDefinitionNode>;
}
interface GraphQLArgumentNormalizedConfig extends GraphQLArgumentConfig {
default: GraphQLDefaultInput | undefined;
extensions: Readonly<GraphQLArgumentExtensions>;
}
/**
* A map of field names to field configuration objects.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
*/
export type GraphQLFieldConfigMap<TSource, TContext> = ObjMap<GraphQLFieldConfig<TSource, TContext>>;
type GraphQLFieldNormalizedConfigMap<TSource, TContext> = ObjMap<GraphQLFieldNormalizedConfig<TSource, TContext>>;
/**
* A resolved GraphQL field definition.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @typeParam TArgs - Argument object type passed to resolvers.
*/
export declare class GraphQLField<TSource = any, TContext = any, TArgs = any> implements GraphQLSchemaElement {
/** Object or interface type that owns this field, if known. */
parentType: GraphQLObjectType<TSource, TContext> | GraphQLInterfaceType<TSource, TContext> | undefined;
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
type: GraphQLOutputType;
/** Arguments accepted by this field or directive. */
args: ReadonlyArray<GraphQLArgument>;
/** Resolver function used to produce this field value. */
resolve?: GraphQLFieldResolver<TSource, TContext, TArgs> | undefined;
/** Resolver function used to create a subscription event stream for this field. */
subscribe?: GraphQLFieldResolver<TSource, TContext, TArgs> | undefined;
/** Reason this element is deprecated, if one was provided. */
deprecationReason: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLFieldExtensions<TSource, TContext, TArgs>>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<FieldDefinitionNode>;
/**
* Creates a resolved GraphQL field definition.
* @param parentType - Object or interface type that owns this field, if known.
* @param name - Field name.
* @param config - Field configuration.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { GraphQLField, GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const document = parse('type Query { greeting: String }');
* const fieldNode = document.definitions[0].fields[0];
* const field = new GraphQLField(Query, 'greeting', {
* description: 'Greeting text.',
* type: GraphQLString,
* args: {
* name: { type: GraphQLString, default: { value: 'world' } },
* },
* resolve: (_source, { name }) => `Hello, ${name}!`,
* subscribe: async function* () {
* yield { greeting: 'Hello!' };
* },
* deprecationReason: 'Use hello.',
* extensions: { cacheSeconds: 60 },
* astNode: fieldNode,
* });
*
* field.parentType; // => Query
* field.name; // => 'greeting'
* field.args[0].default.value; // => 'world'
* typeof field.subscribe; // => 'function'
* field.deprecationReason; // => 'Use hello.'
* field.astNode; // => fieldNode
* ```
*/
constructor(parentType: GraphQLObjectType<TSource, TContext> | GraphQLInterfaceType<TSource, TContext> | undefined, name: string, config: GraphQLFieldConfig<TSource, TContext, TArgs>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a normalized configuration object for this field.
* @returns A configuration object that can be used to recreate this field.
* @example
* ```ts
* import { GraphQLField, GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', {
* type: GraphQLString,
* extensions: { cacheSeconds: 60 },
* });
*
* field.toConfig().type; // => GraphQLString
* field.toConfig().extensions; // => { cacheSeconds: 60 }
* ```
*/
toConfig(): GraphQLFieldNormalizedConfig<TSource, TContext, TArgs>;
/**
* Returns this field as a schema coordinate string.
* @returns The field coordinate.
* @example
* ```ts
* import { GraphQLField, GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', { type: GraphQLString });
*
* field.toString(); // => 'Query.greeting'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The field coordinate.
* @example
* ```ts
* import { GraphQLField, GraphQLObjectType, GraphQLString } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', { type: GraphQLString });
*
* JSON.stringify(field); // => '"Query.greeting"'
* ```
*/
toJSON(): string;
}
/** A resolved GraphQL argument definition. */
export declare class GraphQLArgument implements GraphQLSchemaElement {
/** Field or directive that owns this argument. */
parent: GraphQLField | GraphQLDirective;
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
type: GraphQLInputType;
/**
* Deprecated legacy default value used when no explicit value is supplied.
* Use `default` instead.
* @deprecated use `default` instead, `defaultValue` will be removed in v18
*/
defaultValue: unknown;
/** Default value represented as either a runtime value or a GraphQL literal. */
default: GraphQLDefaultInput | undefined;
/** Reason this element is deprecated, if one was provided. */
deprecationReason: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLArgumentExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<InputValueDefinitionNode>;
/**
* Creates a resolved GraphQL argument definition.
* @param parent - Field or directive that owns this argument.
* @param name - Argument name.
* @param config - Argument configuration.
* @example
* ```ts
* import {
* GraphQLArgument,
* GraphQLField,
* GraphQLObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', { type: GraphQLString });
* const arg = new GraphQLArgument(field, 'name', {
* type: GraphQLString,
* default: { value: 'world' },
* });
*
* arg.parent; // => field
* arg.name; // => 'name'
* arg.default.value; // => 'world'
* ```
*/
constructor(parent: GraphQLField | GraphQLDirective, name: string, config: GraphQLArgumentConfig);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a normalized configuration object for this argument.
* @returns A configuration object that can be used to recreate this argument.
* @example
* ```ts
* import {
* GraphQLArgument,
* GraphQLField,
* GraphQLObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', { type: GraphQLString });
* const arg = new GraphQLArgument(field, 'name', {
* type: GraphQLString,
* default: { value: 'world' },
* });
*
* arg.toConfig().default.value; // => 'world'
* ```
*/
toConfig(): GraphQLArgumentNormalizedConfig;
/**
* Returns this argument as a schema coordinate string.
* @returns The argument coordinate.
* @example
* ```ts
* import {
* GraphQLArgument,
* GraphQLField,
* GraphQLObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', { type: GraphQLString });
* const arg = new GraphQLArgument(field, 'name', { type: GraphQLString });
*
* arg.toString(); // => 'Query.greeting(name:)'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The argument coordinate.
* @example
* ```ts
* import {
* GraphQLArgument,
* GraphQLField,
* GraphQLObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'greeting', { type: GraphQLString });
* const arg = new GraphQLArgument(field, 'name', { type: GraphQLString });
*
* JSON.stringify(arg); // => '"Query.greeting(name:)"'
* ```
*/
toJSON(): string;
}
/**
* Returns true when the argument is non-null and has no default value.
* @param arg - The argument definition to inspect.
* @returns True when the argument is non-null and has no default value.
* @example
* ```ts
* import {
* GraphQLArgument,
* GraphQLField,
* GraphQLInt,
* GraphQLNonNull,
* GraphQLObjectType,
* GraphQLString,
* isRequiredArgument,
* } from 'graphql/type';
*
* const Query = new GraphQLObjectType({ name: 'Query', fields: {} });
* const field = new GraphQLField(Query, 'reviews', { type: GraphQLString });
* const requiredArgument = new GraphQLArgument(field, 'id', {
* type: new GraphQLNonNull(GraphQLInt),
* });
* const optionalArgument = new GraphQLArgument(field, 'name', {
* type: GraphQLString,
* });
* const argumentWithDefault = new GraphQLArgument(field, 'limit', {
* type: new GraphQLNonNull(GraphQLInt),
* default: { value: 10 },
* });
*
* isRequiredArgument(requiredArgument); // => true
* isRequiredArgument(optionalArgument); // => false
* isRequiredArgument(argumentWithDefault); // => false
* ```
*/
export declare function isRequiredArgument(arg: GraphQLArgument | GraphQLVariableSignature): boolean;
/**
* A map of field names to resolved field definitions.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
*/
export type GraphQLFieldMap<TSource, TContext> = ObjMap<GraphQLField<TSource, TContext>>;
/** Default input represented as either a runtime value or a GraphQL literal. */
export type GraphQLDefaultInput = {
/** Runtime default value. */
value: unknown;
/** GraphQL literal default value is not provided in this variant. */
literal?: never;
} | {
/** GraphQL literal default value. */
literal: ConstValueNode;
/** Runtime default value is not provided in this variant. */
value?: never;
};
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLInterfaceTypeExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Interface Type Definition
*
* When a field can return one of a heterogeneous set of types, a Interface type
* is used to describe what types are possible, what fields are in common across
* all types, as well as a function to determine which type is actually used
* when the field is resolved.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @example
* ```ts
* const EntityType = new GraphQLInterfaceType({
* name: 'Entity',
* fields: {
* name: { type: GraphQLString },
* },
* });
* ```
*/
export declare class GraphQLInterfaceType<TSource = any, TContext = any> implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Function that resolves the concrete object type for this abstract type. */
resolveType: Maybe<GraphQLTypeResolver<TSource, TContext>>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLInterfaceTypeExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<InterfaceTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<InterfaceTypeExtensionNode>;
private _fields;
private _interfaces;
/**
* Creates a GraphQLInterfaceType instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { GraphQLID, GraphQLInterfaceType, GraphQLNonNull } from 'graphql/type';
*
* const document = parse(`
* interface Node {
* id: ID!
* }
*
* interface Resource implements Node {
* id: ID!
* }
*
* extend interface Resource {
* url: String
* }
* `);
*
* const Node = new GraphQLInterfaceType({
* name: 'Node',
* fields: {
* id: { type: new GraphQLNonNull(GraphQLID) },
* },
* });
*
* const Resource = new GraphQLInterfaceType({
* name: 'Resource',
* description: 'An addressable resource.',
* interfaces: [Node],
* fields: {
* id: { type: new GraphQLNonNull(GraphQLID) },
* },
* resolveType: (value) => {
* return typeof value === 'object' && value != null && 'url' in value
* ? 'WebPage'
* : null;
* },
* extensions: { abstract: true },
* astNode: document.definitions[1],
* extensionASTNodes: [document.definitions[2]],
* });
*
* Resource.name; // => 'Resource'
* Resource.getInterfaces(); // => [Node]
* Object.keys(Resource.getFields()); // => ['id']
* Resource.extensions; // => { abstract: true }
* ```
*/
constructor(config: Readonly<GraphQLInterfaceTypeConfig<TSource, TContext>>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the fields defined by this type.
* @returns The fields keyed by field name.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
*
* const Node = assertInterfaceType(schema.getType('Node'));
* const fields = Node.getFields();
*
* Object.keys(fields); // => ['id']
* String(fields.id.type); // => 'ID!'
* ```
*/
getFields(): GraphQLFieldMap<TSource, TContext>;
/**
* Returns the interfaces implemented by this type.
* @returns The implemented interfaces.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Resource {
* url: String!
* }
*
* interface Image implements Resource {
* url: String!
* width: Int
* }
*
* type Photo implements Resource & Image {
* url: String!
* width: Int
* }
*
* type Query {
* image: Image
* }
* `);
*
* const Image = assertInterfaceType(schema.getType('Image'));
*
* Image.getInterfaces().map((type) => type.name); // => ['Resource']
* ```
*/
getInterfaces(): ReadonlyArray<GraphQLInterfaceType>;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import { GraphQLID, GraphQLInterfaceType, GraphQLNonNull } from 'graphql/type';
*
* const Node = new GraphQLInterfaceType({
* name: 'Node',
* fields: {
* id: { type: new GraphQLNonNull(GraphQLID) },
* },
* });
*
* const config = Node.toConfig();
* const NodeCopy = new GraphQLInterfaceType(config);
*
* String(config.fields.id.type); // => 'ID!'
* String(NodeCopy.getFields().id.type); // => 'ID!'
* ```
*/
toConfig(): GraphQLInterfaceTypeNormalizedConfig<TSource, TContext>;
/**
* Returns the schema coordinate identifying this interface type.
* @returns The schema coordinate for this interface type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
*
* const Node = assertInterfaceType(schema.getType('Node'));
*
* Node.toString(); // => 'Node'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLInterfaceType, GraphQLString } from 'graphql/type';
*
* const Named = new GraphQLInterfaceType({
* name: 'Named',
* fields: { name: { type: GraphQLString } },
* });
*
* Named.toJSON(); // => 'Named'
* JSON.stringify({ type: Named }); // => '{"type":"Named"}'
* ```
*/
toJSON(): string;
}
/**
* Configuration used to construct a GraphQLInterfaceType.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
*/
export interface GraphQLInterfaceTypeConfig<TSource, TContext> {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Interfaces implemented by this object or interface type. */
interfaces?: ThunkReadonlyArray<GraphQLInterfaceType> | undefined;
/** Fields declared by this object, interface, input object, or literal. */
fields: ThunkObjMap<GraphQLFieldConfig<TSource, TContext>>;
/**
* Optionally provide a custom type resolver function. If one is not provided,
* the default implementation will call `isTypeOf` on each implementing
* Object type.
*/
resolveType?: Maybe<GraphQLTypeResolver<TSource, TContext>>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLInterfaceTypeExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<InterfaceTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<InterfaceTypeExtensionNode>>;
}
interface GraphQLInterfaceTypeNormalizedConfig<TSource, TContext> extends GraphQLInterfaceTypeConfig<TSource, TContext> {
interfaces: ReadonlyArray<GraphQLInterfaceType>;
fields: GraphQLFieldNormalizedConfigMap<TSource, TContext>;
extensions: Readonly<GraphQLInterfaceTypeExtensions>;
extensionASTNodes: ReadonlyArray<InterfaceTypeExtensionNode>;
}
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLUnionTypeExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Union Type Definition
*
* When a field can return one of a heterogeneous set of types, a Union type
* is used to describe what types are possible as well as providing a function
* to determine which type is actually used when the field is resolved.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
* @example
* ```ts
* const PetType = new GraphQLUnionType({
* name: 'Pet',
* types: [DogType, CatType],
* resolveType: (value) => {
* if (value instanceof Dog) {
* return DogType;
* }
* if (value instanceof Cat) {
* return CatType;
* }
* },
* });
* ```
*/
export declare class GraphQLUnionType<TSource = any, TContext = any> implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Function that resolves the concrete object type for this abstract type. */
resolveType: Maybe<GraphQLTypeResolver<TSource, TContext>>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLUnionTypeExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<UnionTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<UnionTypeExtensionNode>;
private _types;
/**
* Creates a GraphQLUnionType instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import {
* GraphQLObjectType,
* GraphQLString,
* GraphQLUnionType,
* } from 'graphql/type';
*
* const document = parse(`
* union Media = Photo | Video
*
* extend union Media = Audio
* `);
*
* const Photo = new GraphQLObjectType({
* name: 'Photo',
* fields: { url: { type: GraphQLString } },
* });
* const Video = new GraphQLObjectType({
* name: 'Video',
* fields: { url: { type: GraphQLString } },
* });
*
* const Media = new GraphQLUnionType({
* name: 'Media',
* description: 'Media that can appear in a search result.',
* types: [Photo, Video],
* resolveType: (value) => {
* return typeof value === 'object' && value != null && 'duration' in value
* ? 'Video'
* : 'Photo';
* },
* extensions: { searchable: true },
* astNode: document.definitions[0],
* extensionASTNodes: [document.definitions[1]],
* });
*
* Media.description; // => 'Media that can appear in a search result.'
* Media.getTypes().map((type) => type.name); // => ['Photo', 'Video']
* Media.extensions; // => { searchable: true }
* ```
*/
constructor(config: Readonly<GraphQLUnionTypeConfig<TSource, TContext>>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the object types included in this union.
* @returns The union member object types.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertUnionType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Photo {
* url: String!
* }
*
* type Video {
* url: String!
* }
*
* union Media = Photo | Video
*
* type Query {
* media: [Media]
* }
* `);
*
* const Media = assertUnionType(schema.getType('Media'));
*
* Media.getTypes().map((type) => type.name); // => ['Photo', 'Video']
* ```
*/
getTypes(): ReadonlyArray<GraphQLObjectType>;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import {
* GraphQLObjectType,
* GraphQLString,
* GraphQLUnionType,
* } from 'graphql/type';
*
* const Photo = new GraphQLObjectType({
* name: 'Photo',
* fields: { url: { type: GraphQLString } },
* });
* const Video = new GraphQLObjectType({
* name: 'Video',
* fields: { url: { type: GraphQLString } },
* });
* const Media = new GraphQLUnionType({
* name: 'Media',
* types: [Photo, Video],
* });
*
* const config = Media.toConfig();
* const MediaCopy = new GraphQLUnionType(config);
*
* MediaCopy.getTypes().map((type) => type.name); // => ['Photo', 'Video']
* ```
*/
toConfig(): GraphQLUnionTypeNormalizedConfig<TSource, TContext>;
/**
* Returns the schema coordinate identifying this union type.
* @returns The schema coordinate for this union type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertUnionType } from 'graphql/type';
*
* const schema = buildSchema(`
* type Photo {
* url: String!
* }
*
* union SearchResult = Photo
*
* type Query {
* search: [SearchResult]
* }
* `);
*
* const SearchResult = assertUnionType(schema.getType('SearchResult'));
*
* SearchResult.toString(); // => 'SearchResult'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import {
* GraphQLObjectType,
* GraphQLString,
* GraphQLUnionType,
* } from 'graphql/type';
*
* const Photo = new GraphQLObjectType({
* name: 'Photo',
* fields: { url: { type: GraphQLString } },
* });
* const SearchResult = new GraphQLUnionType({
* name: 'SearchResult',
* types: [Photo],
* });
*
* SearchResult.toJSON(); // => 'SearchResult'
* JSON.stringify({ type: SearchResult }); // => '{"type":"SearchResult"}'
* ```
*/
toJSON(): string;
}
/**
* Configuration used to construct a GraphQLUnionType.
* @typeParam TSource - Source object type passed to resolvers.
* @typeParam TContext - Context object type passed to resolvers.
*/
export interface GraphQLUnionTypeConfig<TSource, TContext> {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Object types that belong to this union type. */
types: ThunkReadonlyArray<GraphQLObjectType>;
/**
* Optionally provide a custom type resolver function. If one is not provided,
* the default implementation will call `isTypeOf` on each implementing
* Object type.
*/
resolveType?: Maybe<GraphQLTypeResolver<TSource, TContext>>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLUnionTypeExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<UnionTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<UnionTypeExtensionNode>>;
}
interface GraphQLUnionTypeNormalizedConfig<TSource, TContext> extends GraphQLUnionTypeConfig<TSource, TContext> {
types: ReadonlyArray<GraphQLObjectType>;
extensions: Readonly<GraphQLUnionTypeExtensions>;
extensionASTNodes: ReadonlyArray<UnionTypeExtensionNode>;
}
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLEnumTypeExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Enum Type Definition
*
* Enum types define leaf values whose serialized form is one of a fixed set
* of GraphQL enum names. Internally, enum values can map to any runtime value,
* often integers.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGBType = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGBType.getValue('GREEN')?.value; // => 1
* ```
*
* Note: If a value is not provided in a definition, the name of the enum value
* will be used as its internal value.
*/
export declare class GraphQLEnumType /* <T> *//* <T> */ implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLEnumTypeExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<EnumTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<EnumTypeExtensionNode>;
private _values;
private _valueLookup;
private _nameLookup;
/**
* Creates a GraphQLEnumType instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { GraphQLEnumType } from 'graphql/type';
*
* const document = parse(`
* enum Episode {
* NEW_HOPE
* EMPIRE
* JEDI
* }
*
* extend enum Episode {
* FORCE_AWAKENS
* }
* `);
* const definition = document.definitions[0];
*
* const Episode = new GraphQLEnumType({
* name: 'Episode',
* description: 'A Star Wars film episode.',
* values: {
* NEW_HOPE: {
* value: 4,
* description: 'Released in 1977.',
* extensions: { trilogy: 'original' },
* astNode: definition.values[0],
* },
* EMPIRE: { value: 5, astNode: definition.values[1] },
* JEDI: {
* value: 6,
* deprecationReason: 'Use RETURN_OF_THE_JEDI.',
* astNode: definition.values[2],
* },
* },
* extensions: { catalog: 'films' },
* astNode: definition,
* extensionASTNodes: [document.definitions[1]],
* });
*
* Episode.description; // => 'A Star Wars film episode.'
* Episode.coerceOutputValue(5); // => 'EMPIRE'
* Episode.coerceInputValue('JEDI'); // => 6
* Episode.getValue('JEDI').deprecationReason; // => 'Use RETURN_OF_THE_JEDI.'
* Episode.extensions; // => { catalog: 'films' }
* ```
*/
constructor(config: Readonly<GraphQLEnumTypeConfig>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the values defined by this enum type.
* @returns Enum value definitions in schema order.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertEnumType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* EMPIRE
* JEDI
* }
*
* type Query {
* episode: Episode
* }
* `);
*
* const Episode = assertEnumType(schema.getType('Episode'));
*
* Episode.getValues().map((value) => value.name); // => ['NEW_HOPE', 'EMPIRE', 'JEDI']
* ```
*/
getValues(): ReadonlyArray<GraphQLEnumValue>;
/**
* Returns the enum value definition for a value name.
* @param name - The GraphQL name to look up.
* @returns The matching enum value definition, if it exists.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertEnumType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* EMPIRE
* }
*
* type Query {
* episode: Episode
* }
* `);
*
* const Episode = assertEnumType(schema.getType('Episode'));
*
* Episode.getValue('EMPIRE')?.name; // => 'EMPIRE'
* Episode.getValue('JEDI'); // => undefined
* ```
*/
getValue(name: string): Maybe<GraphQLEnumValue>;
/**
* Serializes a runtime enum value as a GraphQL enum name.
* @param outputValue - Runtime enum value to serialize.
* @returns The GraphQL enum name for the runtime value.
*
* This deprecated method delegates to `coerceOutputValue()`; call
* `coerceOutputValue()` directly instead.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGB.serialize(1); // => 'GREEN'
* RGB.serialize(3); // throws an error
* ```
* @deprecated use `coerceOutputValue()` instead, `serialize()` will be removed in v18
*/
serialize(outputValue: unknown): Maybe<string>;
/**
* Coerces a runtime enum value to a GraphQL enum name.
* @param outputValue - Runtime enum value to coerce.
* @returns The GraphQL enum name for the runtime value.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGB.coerceOutputValue(1); // => 'GREEN'
* RGB.coerceOutputValue(3); // throws an error
* ```
*/
coerceOutputValue(outputValue: unknown): Maybe<string>;
/**
* Deprecated legacy enum parser for externally provided input values. Use
* `coerceInputValue()` instead.
* @param inputValue - External enum name to parse.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns The internal runtime value for the enum name.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGB.parseValue('BLUE'); // => 2
* RGB.parseValue('PURPLE', true); // throws an error
* ```
* @deprecated use `coerceInputValue()` instead, `parseValue()` will be removed in v18
*/
parseValue(inputValue: unknown, hideSuggestions?: Maybe<boolean>): Maybe<any>;
/**
* Coerces an external enum name to its internal runtime value.
* @param inputValue - External enum name to coerce.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns The internal runtime value for the enum name.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGB.coerceInputValue('BLUE'); // => 2
* RGB.coerceInputValue('PURPLE'); // throws an error
* RGB.coerceInputValue(2); // throws an error
* ```
*/
coerceInputValue(inputValue: unknown, hideSuggestions?: Maybe<boolean>): Maybe<any>;
/**
* Deprecated legacy enum parser for externally provided input literals. Use
* `coerceInputLiteral()` instead.
* @param valueNode - Enum value AST node to parse.
* @param _variables - Deprecated variable values parameter that is no longer used.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns The internal runtime value for the enum literal.
* @example
* ```ts
* import { parseValue } from 'graphql/language';
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGB.parseLiteral(parseValue('RED')); // => 0
* RGB.parseLiteral(parseValue('"RED"')); // throws an error
* ```
* @deprecated use `coerceInputLiteral()` instead, `parseLiteral()` will be removed in v18
*/
parseLiteral(valueNode: ValueNode, _variables: Maybe<ObjMap<unknown>>, hideSuggestions?: Maybe<boolean>): Maybe<any>;
/**
* Coerces an enum value AST node to its internal runtime value.
* @param valueNode - Enum value AST node to coerce.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns The internal runtime value for the enum literal.
* @example
* ```ts
* import { parseConstValue } from 'graphql/language';
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* RGB.coerceInputLiteral(parseConstValue('RED')); // => 0
* RGB.coerceInputLiteral(parseConstValue('"RED"'), true); // throws an error
* ```
*/
coerceInputLiteral(valueNode: ConstValueNode, hideSuggestions?: Maybe<boolean>): Maybe<any>;
/**
* Converts a runtime enum value to a GraphQL enum value AST node.
* @param value - Runtime enum value to convert.
* @returns Enum value AST node, or undefined if the value is invalid.
* @example
* ```ts
* import { print } from 'graphql/language';
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* print(RGB.valueToLiteral(2)); // => 'BLUE'
* RGB.valueToLiteral(3); // => undefined
* ```
*/
valueToLiteral(value: unknown): ConstValueNode | undefined;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const RGB = new GraphQLEnumType({
* name: 'RGB',
* values: {
* RED: { value: 0 },
* GREEN: { value: 1 },
* BLUE: { value: 2 },
* },
* });
*
* const config = RGB.toConfig();
* const RGBCopy = new GraphQLEnumType(config);
*
* config.values.GREEN.value; // => 1
* RGBCopy.coerceOutputValue(2); // => 'BLUE'
* ```
*/
toConfig(): GraphQLEnumTypeNormalizedConfig;
/**
* Returns the schema coordinate identifying this enum type.
* @returns The schema coordinate for this enum type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertEnumType } from 'graphql/type';
*
* const schema = buildSchema(`
* enum Episode {
* NEW_HOPE
* }
*
* type Query {
* episode: Episode
* }
* `);
*
* const Episode = assertEnumType(schema.getType('Episode'));
*
* Episode.toString(); // => 'Episode'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLEnumType } from 'graphql/type';
*
* const Episode = new GraphQLEnumType({
* name: 'Episode',
* values: {
* NEW_HOPE: {},
* },
* });
*
* Episode.toJSON(); // => 'Episode'
* JSON.stringify({ type: Episode }); // => '{"type":"Episode"}'
* ```
*/
toJSON(): string;
}
/** Configuration used to construct a GraphQLEnumType. */
export interface GraphQLEnumTypeConfig {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Values contained in this enum, list, or input-object definition. */
values: ThunkObjMap<GraphQLEnumValueConfig>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLEnumTypeExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<EnumTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<EnumTypeExtensionNode>>;
}
interface GraphQLEnumTypeNormalizedConfig extends GraphQLEnumTypeConfig {
values: GraphQLEnumValueNormalizedConfigMap;
extensions: Readonly<GraphQLEnumTypeExtensions>;
extensionASTNodes: ReadonlyArray<EnumTypeExtensionNode>;
}
/** A map of enum value names to enum value configuration objects. */
export type GraphQLEnumValueConfigMap = ObjMap<GraphQLEnumValueConfig>;
type GraphQLEnumValueNormalizedConfigMap = ObjMap<GraphQLEnumValueNormalizedConfig>;
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLEnumValueExtensions {
[attributeName: string | symbol]: unknown;
}
/** Configuration used to define a GraphQL enum value. */
export interface GraphQLEnumValueConfig {
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Parsed value represented by this node. */
value?: any;
/** Reason this element is deprecated, if one was provided. */
deprecationReason?: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLEnumValueExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<EnumValueDefinitionNode>;
}
interface GraphQLEnumValueNormalizedConfig extends GraphQLEnumValueConfig {
extensions: Readonly<GraphQLEnumValueExtensions>;
}
/** A resolved GraphQL enum value definition. */
export declare class GraphQLEnumValue implements GraphQLSchemaElement {
/** Enum type that owns this enum value. */
parentEnum: GraphQLEnumType;
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Parsed value represented by this node. */
value: any;
/** Reason this element is deprecated, if one was provided. */
deprecationReason: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLEnumValueExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<EnumValueDefinitionNode>;
/**
* Creates a resolved GraphQL enum value definition.
* @param parentEnum - Enum type that owns this enum value.
* @param name - Enum value name.
* @param config - Enum value configuration.
* @example
* ```ts
* import { GraphQLEnumType, GraphQLEnumValue } from 'graphql/type';
*
* const Episode = new GraphQLEnumType({
* name: 'Episode',
* values: { NEW_HOPE: { value: 4 } },
* });
* const enumValue = new GraphQLEnumValue(Episode, 'EMPIRE', {
* value: 5,
* description: 'Released in 1980.',
* });
*
* enumValue.parentEnum; // => Episode
* enumValue.name; // => 'EMPIRE'
* enumValue.value; // => 5
* ```
*/
constructor(parentEnum: GraphQLEnumType, name: string, config: GraphQLEnumValueConfig);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a normalized configuration object for this enum value.
* @returns A configuration object that can be used to recreate this enum value.
* @example
* ```ts
* import { GraphQLEnumType, GraphQLEnumValue } from 'graphql/type';
*
* const Episode = new GraphQLEnumType({
* name: 'Episode',
* values: { NEW_HOPE: { value: 4 } },
* });
* const enumValue = new GraphQLEnumValue(Episode, 'EMPIRE', {
* value: 5,
* extensions: { trilogy: 'original' },
* });
*
* enumValue.toConfig(); // => { description: undefined, value: 5, deprecationReason: undefined, extensions: { trilogy: 'original' }, astNode: undefined }
* ```
*/
toConfig(): GraphQLEnumValueNormalizedConfig;
/**
* Returns this enum value as a schema coordinate string.
* @returns Enum value coordinate.
* @example
* ```ts
* import { GraphQLEnumType, GraphQLEnumValue } from 'graphql/type';
*
* const Episode = new GraphQLEnumType({
* name: 'Episode',
* values: { NEW_HOPE: { value: 4 } },
* });
* const enumValue = new GraphQLEnumValue(Episode, 'EMPIRE', { value: 5 });
*
* enumValue.toString(); // => 'Episode.EMPIRE'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns Enum value coordinate.
* @example
* ```ts
* import { GraphQLEnumType, GraphQLEnumValue } from 'graphql/type';
*
* const Episode = new GraphQLEnumType({
* name: 'Episode',
* values: { NEW_HOPE: { value: 4 } },
* });
* const enumValue = new GraphQLEnumValue(Episode, 'EMPIRE', { value: 5 });
*
* JSON.stringify(enumValue); // => '"Episode.EMPIRE"'
* ```
*/
toJSON(): string;
}
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLInputObjectTypeExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Input Object Type Definition
*
* An input object defines a structured collection of fields which may be
* supplied to a field argument.
*
* Using `NonNull` will ensure that a value must be provided by the query
* @example
* ```ts
* const GeoPoint = new GraphQLInputObjectType({
* name: 'GeoPoint',
* fields: {
* lat: { type: new GraphQLNonNull(GraphQLFloat) },
* lon: { type: new GraphQLNonNull(GraphQLFloat) },
* alt: { type: GraphQLFloat, default: { value: 0 } },
* },
* });
* ```
*/
export declare class GraphQLInputObjectType implements GraphQLSchemaElement {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLInputObjectTypeExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<InputObjectTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<InputObjectTypeExtensionNode>;
/** Whether this input object uses the experimental OneOf input object semantics. */
isOneOf: boolean;
private _fields;
/**
* Creates a GraphQLInputObjectType instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import {
* GraphQLID,
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLNonNull,
* GraphQLString,
* } from 'graphql/type';
*
* const document = parse(`
* input ReviewInput {
* stars: Int!
* commentary: String
* }
*
* extend input ReviewInput {
* body: String
* }
* `);
* const definition = document.definitions[0];
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* description: 'Input collected when reviewing a product.',
* fields: {
* stars: {
* description: 'Star rating from one to five.',
* type: new GraphQLNonNull(GraphQLInt),
* extensions: { min: 1, max: 5 },
* astNode: definition.fields[0],
* },
* commentary: {
* type: GraphQLString,
* default: { value: '' },
* deprecationReason: 'Use body.',
* astNode: definition.fields[1],
* },
* },
* extensions: { form: 'review' },
* astNode: definition,
* extensionASTNodes: [document.definitions[1]],
* isOneOf: false,
* });
* const SearchBy = new GraphQLInputObjectType({
* name: 'SearchBy',
* fields: {
* id: { type: GraphQLID },
* slug: { type: GraphQLString },
* },
* isOneOf: true,
* });
*
* const fields = ReviewInput.getFields();
*
* ReviewInput.description; // => 'Input collected when reviewing a product.'
* String(fields.stars.type); // => 'Int!'
* fields.stars.extensions; // => { min: 1, max: 5 }
* fields.commentary.default.value; // => ''
* fields.commentary.deprecationReason; // => 'Use body.'
* ReviewInput.isOneOf; // => false
* SearchBy.isOneOf; // => true
* ```
*/
constructor(config: Readonly<GraphQLInputObjectTypeConfig>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the fields defined by this type.
* @returns The fields keyed by field name.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInputObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* commentary: String = ""
* }
*
* type Query {
* reviews(filter: ReviewInput): [String]
* }
* `);
*
* const ReviewInput = assertInputObjectType(schema.getType('ReviewInput'));
* const fields = ReviewInput.getFields();
*
* Object.keys(fields); // => ['stars', 'commentary']
* fields.commentary.default; // => { literal: { kind: 'StringValue', value: '' } }
* ```
*/
getFields(): GraphQLInputFieldMap;
/**
* Returns a normalized configuration object for this object.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLNonNull,
* } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* },
* });
*
* const config = ReviewInput.toConfig();
* const ReviewInputCopy = new GraphQLInputObjectType(config);
*
* String(config.fields.stars.type); // => 'Int!'
* String(ReviewInputCopy.getFields().stars.type); // => 'Int!'
* ```
*/
toConfig(): GraphQLInputObjectTypeNormalizedConfig;
/**
* Returns the schema coordinate identifying this input object type.
* @returns The schema coordinate for this input object type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInputObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* input ReviewInput {
* stars: Int!
* }
*
* type Query {
* reviews(filter: ReviewInput): [String]
* }
* `);
*
* const ReviewInput = assertInputObjectType(schema.getType('ReviewInput'));
*
* ReviewInput.toString(); // => 'ReviewInput'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The JSON-serializable representation.
* @example
* ```ts
* import { GraphQLInputObjectType, GraphQLString } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* commentary: { type: GraphQLString },
* },
* });
*
* ReviewInput.toJSON(); // => 'ReviewInput'
* JSON.stringify({ type: ReviewInput }); // => '{"type":"ReviewInput"}'
* ```
*/
toJSON(): string;
}
/** Configuration used to construct a GraphQLInputObjectType. */
export interface GraphQLInputObjectTypeConfig {
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Fields declared by this object, interface, input object, or literal. */
fields: ThunkObjMap<GraphQLInputFieldConfig>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLInputObjectTypeExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<InputObjectTypeDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<InputObjectTypeExtensionNode>>;
/** Whether this input object uses the experimental OneOf input object semantics. */
isOneOf?: boolean;
}
interface GraphQLInputObjectTypeNormalizedConfig extends GraphQLInputObjectTypeConfig {
fields: GraphQLInputFieldNormalizedConfigMap;
extensions: Readonly<GraphQLInputObjectTypeExtensions>;
extensionASTNodes: ReadonlyArray<InputObjectTypeExtensionNode>;
}
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLInputFieldExtensions {
[attributeName: string | symbol]: unknown;
}
/** Configuration used to define a GraphQL input field. */
export interface GraphQLInputFieldConfig {
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
type: GraphQLInputType;
/**
* Deprecated legacy default value for this input field. Use `default`
* instead.
* @deprecated use `default` instead, `defaultValue` will be removed in v18
*/
defaultValue?: unknown;
/** Default value represented as either a runtime value or a GraphQL literal. */
default?: GraphQLDefaultInput | undefined;
/** Reason this element is deprecated, if one was provided. */
deprecationReason?: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLInputFieldExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<InputValueDefinitionNode>;
}
/** A map of input field names to input field configuration objects. */
export type GraphQLInputFieldConfigMap = ObjMap<GraphQLInputFieldConfig>;
interface GraphQLInputFieldNormalizedConfig extends GraphQLInputFieldConfig {
default: GraphQLDefaultInput | undefined;
extensions: Readonly<GraphQLInputFieldExtensions>;
}
type GraphQLInputFieldNormalizedConfigMap = ObjMap<GraphQLInputFieldNormalizedConfig>;
/** A resolved GraphQL input field definition. */
export declare class GraphQLInputField implements GraphQLSchemaElement {
/** Input object type that owns this input field. */
parentType: GraphQLInputObjectType;
/** The GraphQL name for this schema element. */
name: string;
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
type: GraphQLInputType;
/**
* Deprecated legacy default value used when no explicit value is supplied.
* Use `default` instead.
* @deprecated use `default` instead, `defaultValue` will be removed in v18
*/
defaultValue: unknown;
/** Default value represented as either a runtime value or a GraphQL literal. */
default: GraphQLDefaultInput | undefined;
/** Reason this element is deprecated, if one was provided. */
deprecationReason: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLInputFieldExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<InputValueDefinitionNode>;
/**
* Creates a resolved GraphQL input field definition.
* @param parentType - Input object type that owns this field.
* @param name - Input field name.
* @param config - Input field configuration.
* @example
* ```ts
* import {
* GraphQLInputField,
* GraphQLInputObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {},
* });
* const field = new GraphQLInputField(ReviewInput, 'commentary', {
* type: GraphQLString,
* default: { value: '' },
* });
*
* field.parentType; // => ReviewInput
* field.name; // => 'commentary'
* field.default.value; // => ''
* ```
*/
constructor(parentType: GraphQLInputObjectType, name: string, config: GraphQLInputFieldConfig);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns a normalized configuration object for this input field.
* @returns A configuration object that can be used to recreate this input field.
* @example
* ```ts
* import {
* GraphQLInputField,
* GraphQLInputObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {},
* });
* const field = new GraphQLInputField(ReviewInput, 'commentary', {
* type: GraphQLString,
* extensions: { form: 'review' },
* });
*
* field.toConfig().extensions; // => { form: 'review' }
* ```
*/
toConfig(): GraphQLInputFieldNormalizedConfig;
/**
* Returns this input field as a schema coordinate string.
* @returns The input field coordinate.
* @example
* ```ts
* import {
* GraphQLInputField,
* GraphQLInputObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {},
* });
* const field = new GraphQLInputField(ReviewInput, 'commentary', {
* type: GraphQLString,
* });
*
* field.toString(); // => 'ReviewInput.commentary'
* ```
*/
toString(): string;
/**
* Returns the JSON representation used when this object is serialized.
* @returns The input field coordinate.
* @example
* ```ts
* import {
* GraphQLInputField,
* GraphQLInputObjectType,
* GraphQLString,
* } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {},
* });
* const field = new GraphQLInputField(ReviewInput, 'commentary', {
* type: GraphQLString,
* });
*
* JSON.stringify(field); // => '"ReviewInput.commentary"'
* ```
*/
toJSON(): string;
}
/**
* Returns true when the input field is non-null and has no default value.
* @param field - The input field definition to inspect.
* @returns True when the input field is non-null and has no default value.
* @example
* ```ts
* import {
* GraphQLInputField,
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLNonNull,
* GraphQLString,
* isRequiredInputField,
* } from 'graphql/type';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {},
* });
* const requiredField = new GraphQLInputField(ReviewInput, 'id', {
* type: new GraphQLNonNull(GraphQLInt),
* });
* const optionalField = new GraphQLInputField(ReviewInput, 'name', {
* type: GraphQLString,
* });
* const fieldWithDefault = new GraphQLInputField(ReviewInput, 'limit', {
* type: new GraphQLNonNull(GraphQLInt),
* default: { value: 10 },
* });
*
* isRequiredInputField(requiredField); // => true
* isRequiredInputField(optionalField); // => false
* isRequiredInputField(fieldWithDefault); // => false
* ```
*/
export declare function isRequiredInputField(field: GraphQLInputField): boolean;
/** A map of input field names to resolved input field definitions. */
export type GraphQLInputFieldMap = ObjMap<GraphQLInputField>;
/**
* Test if the given value is a GraphQL schema.
* @param schema - Value to inspect.
* @returns True when the value is a GraphQLSchema.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { GraphQLString, isSchema } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* isSchema(schema); // => true
* isSchema(GraphQLString); // => false
* ```
*/
export declare function isSchema(schema: unknown): schema is GraphQLSchema;
/**
* Returns the value as a GraphQLSchema, or throws if it is not a schema.
* @param schema - GraphQL schema to use.
* @returns The value typed as a GraphQLSchema.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertSchema, GraphQLString } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* assertSchema(schema); // => schema
* assertSchema(GraphQLString); // throws an error
* ```
*/
export declare function assertSchema(schema: unknown): GraphQLSchema;
/**
* Custom extensions
* @remarks
* Use a unique identifier name for your extension, for example the name of
* your library or project. Do not use a shortened identifier as this increases
* the risk of conflicts. We recommend you add at most one extension field,
* an object which can contain all the values you need.
*/
export interface GraphQLSchemaExtensions {
[attributeName: string | symbol]: unknown;
}
/**
* Schema Definition
*
* A Schema is created by supplying the root types of each type of operation,
* query and mutation (optional). A schema definition is then supplied to the
* validator and executor.
* @example
* ```ts
* const MyAppQueryRootType = new GraphQLObjectType({
* name: 'Query',
* fields: {
* greeting: { type: GraphQLString },
* },
* });
*
* const MyAppMutationRootType = new GraphQLObjectType({
* name: 'Mutation',
* fields: {
* setGreeting: { type: GraphQLString },
* },
* });
*
* const MyAppSchema = new GraphQLSchema({
* query: MyAppQueryRootType,
* mutation: MyAppMutationRootType,
* });
* ```
* @example
* When the schema is constructed, by default only the types that are reachable
* by traversing the root types are included, other types must be explicitly
* referenced.
*
* ```ts
* const characterInterface = new GraphQLInterfaceType({
* name: 'Character',
* fields: {
* name: { type: GraphQLString },
* },
* });
*
* const humanType = new GraphQLObjectType({
* name: 'Human',
* interfaces: [characterInterface],
* fields: {
* name: { type: GraphQLString },
* },
* });
*
* const droidType = new GraphQLObjectType({
* name: 'Droid',
* interfaces: [characterInterface],
* fields: {
* name: { type: GraphQLString },
* },
* });
*
* const schema = new GraphQLSchema({
* query: new GraphQLObjectType({
* name: 'Query',
* fields: {
* hero: { type: characterInterface },
* },
* }),
* // Since this schema references only the `Character` interface it's
* // necessary to explicitly list the types that implement it if
* // you want them to be included in the final schema.
* types: [humanType, droidType],
* });
* ```
* @example
* If an array of `directives` are provided to GraphQLSchema, that will be the
* exact list of directives represented and allowed. If `directives` is not
* provided then a default set of the specified directives (e.g. `@include` and
* `@skip`) will be used. If you wish to provide *additional* directives to
* these specified directives, you must explicitly declare them.
*
* ```ts
* const MyAppSchema = new GraphQLSchema({
* query: MyAppQueryRootType,
* directives: specifiedDirectives.concat([myCustomDirective]),
* });
* ```
*/
export declare class GraphQLSchema {
/** Human-readable description for this schema element, if provided. */
description: Maybe<string>;
/** Custom extension fields reserved for users. */
extensions: Readonly<GraphQLSchemaExtensions>;
/** AST node from which this schema element was built, if available. */
astNode: Maybe<SchemaDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes: ReadonlyArray<SchemaExtensionNode>;
/** Whether this schema instance skips validation checks. */
assumeValid: boolean;
private _queryType;
private _mutationType;
private _subscriptionType;
private _directives;
private _typeMap;
private _subTypeMap;
private _implementationsMap;
/**
* Creates a GraphQLSchema instance.
* @param config - Configuration describing this object.
* @example
* ```ts
* // Create a schema with the required query root.
* import { GraphQLObjectType, GraphQLSchema, GraphQLString } from 'graphql/type';
*
* const Query = new GraphQLObjectType({
* name: 'Query',
* fields: {
* greeting: {
* type: GraphQLString,
* resolve: () => 'Hello',
* },
* },
* });
*
* const schema = new GraphQLSchema({
* description: 'The application schema.',
* query: Query,
* });
*
* schema.getQueryType(); // => Query
* schema.description; // => 'The application schema.'
* ```
* @example
* ```ts
* // This variant configures every schema option, including directives and extensions.
* import { DirectiveLocation, parse } from 'graphql/language';
* import {
* GraphQLBoolean,
* GraphQLDirective,
* GraphQLObjectType,
* GraphQLSchema,
* GraphQLString,
* } from 'graphql/type';
*
* const Query = new GraphQLObjectType({
* name: 'Query',
* fields: { greeting: { type: GraphQLString } },
* });
* const Mutation = new GraphQLObjectType({
* name: 'Mutation',
* fields: { setGreeting: { type: GraphQLString } },
* });
* const Subscription = new GraphQLObjectType({
* name: 'Subscription',
* fields: { greetingChanged: { type: GraphQLString } },
* });
* const AuditEvent = new GraphQLObjectType({
* name: 'AuditEvent',
* fields: { message: { type: GraphQLString } },
* });
* const authDirective = new GraphQLDirective({
* name: 'auth',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* args: { required: { type: GraphQLBoolean } },
* });
* const schemaDocument = parse(`
* schema {
* query: Query
* mutation: Mutation
* subscription: Subscription
* }
*
* extend schema @auth
* `);
*
* const schema = new GraphQLSchema({
* description: 'Operations exposed by the application.',
* query: Query,
* mutation: Mutation,
* subscription: Subscription,
* types: [AuditEvent],
* directives: [authDirective],
* extensions: { owner: 'platform' },
* astNode: schemaDocument.definitions[0],
* extensionASTNodes: [schemaDocument.definitions[1]],
* assumeValid: true,
* });
*
* schema.getMutationType(); // => Mutation
* schema.getSubscriptionType(); // => Subscription
* schema.getType('AuditEvent'); // => AuditEvent
* schema.getDirective('auth'); // => authDirective
* schema.extensions; // => { owner: 'platform' }
* ```
*/
constructor(config: Readonly<GraphQLSchemaConfig>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the root object type for query operations.
* @returns The query root type, if this schema defines one.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* schema.getQueryType()?.name; // => 'Query'
* ```
*/
getQueryType(): Maybe<GraphQLObjectType>;
/**
* Returns the root object type for mutation operations.
* @returns The mutation root type, if this schema defines one.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
*
* type Mutation {
* setGreeting(value: String!): String
* }
* `);
*
* schema.getMutationType()?.name; // => 'Mutation'
* ```
*/
getMutationType(): Maybe<GraphQLObjectType>;
/**
* Returns the root object type for subscription operations.
* @returns The subscription root type, if this schema defines one.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
*
* type Subscription {
* greetings: String
* }
* `);
*
* schema.getSubscriptionType()?.name; // => 'Subscription'
* ```
*/
getSubscriptionType(): Maybe<GraphQLObjectType>;
/**
* Returns the root object type for the requested operation kind.
* @param operation - Operation kind to resolve.
* @returns The root object type for the operation kind, if this schema defines one.
* @example
* ```ts
* import { OperationTypeNode } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
*
* type Mutation {
* setGreeting(value: String!): String
* }
* `);
*
* schema.getRootType(OperationTypeNode.QUERY)?.name; // => 'Query'
* schema.getRootType(OperationTypeNode.MUTATION)?.name; // => 'Mutation'
* schema.getRootType(OperationTypeNode.SUBSCRIPTION); // => undefined
* ```
*/
getRootType(operation: OperationTypeNode): Maybe<GraphQLObjectType>;
/**
* Returns all named types known to this schema.
* @returns A map of schema types keyed by type name.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type User {
* name: String
* }
*
* type Query {
* viewer: User
* }
* `);
*
* const typeMap = schema.getTypeMap();
*
* typeMap.User.name; // => 'User'
* typeMap.Query.name; // => 'Query'
* typeMap.String.name; // => 'String'
* ```
*/
getTypeMap(): TypeMap;
/**
* Returns the named type with the provided name.
* @param name - The GraphQL name to look up.
* @returns The named schema type, if one exists.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type User {
* name: String
* }
*
* type Query {
* viewer: User
* }
* `);
*
* schema.getType('User')?.toString(); // => 'User'
* schema.getType('Missing'); // => undefined
* ```
*/
getType(name: string): GraphQLNamedType | undefined;
/**
* Returns object types that may be returned for an abstract type.
* @param abstractType - Interface or union type to inspect.
* @returns Object types that may satisfy the abstract type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType, assertUnionType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Organization implements Node {
* id: ID!
* }
*
* union SearchResult = User | Organization
*
* type Query {
* node: Node
* search: [SearchResult]
* }
* `);
*
* const Node = assertInterfaceType(schema.getType('Node'));
* const SearchResult = assertUnionType(schema.getType('SearchResult'));
*
* schema.getPossibleTypes(Node).map((type) => type.name); // => ['User', 'Organization']
* schema.getPossibleTypes(SearchResult).map((type) => type.name); // => ['User', 'Organization']
* ```
*/
getPossibleTypes(abstractType: GraphQLAbstractType): ReadonlyArray<GraphQLObjectType>;
/**
* Returns objects and interfaces that implement an interface type.
* @param interfaceType - Interface type to inspect.
* @returns Object and interface implementations of the interface.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Resource {
* url: String!
* }
*
* interface Image implements Resource {
* url: String!
* width: Int
* }
*
* type Photo implements Resource & Image {
* url: String!
* width: Int
* }
*
* type Query {
* resource: Resource
* }
* `);
*
* const Resource = assertInterfaceType(schema.getType('Resource'));
* const implementations = schema.getImplementations(Resource);
*
* implementations.interfaces.map((type) => type.name); // => ['Image']
* implementations.objects.map((type) => type.name); // => ['Photo']
* ```
*/
getImplementations(interfaceType: GraphQLInterfaceType): {
objects: ReadonlyArray<GraphQLObjectType>;
interfaces: ReadonlyArray<GraphQLInterfaceType>;
};
/**
* Returns whether one type is a possible runtime subtype of an abstract type.
* @param abstractType - Interface or union type to inspect.
* @param maybeSubType - Object or interface type to test as a possible subtype.
* @returns True when the subtype may satisfy the abstract type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertInterfaceType, assertObjectType } from 'graphql/type';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Review {
* body: String
* }
*
* type Query {
* node: Node
* review: Review
* }
* `);
*
* const Node = assertInterfaceType(schema.getType('Node'));
* const User = assertObjectType(schema.getType('User'));
* const Review = assertObjectType(schema.getType('Review'));
*
* schema.isSubType(Node, User); // => true
* schema.isSubType(Node, Review); // => false
* ```
*/
isSubType(abstractType: GraphQLAbstractType, maybeSubType: GraphQLObjectType | GraphQLInterfaceType): boolean;
/**
* Returns directives available in this schema.
* @returns Directives available in this schema.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* directive @upper on FIELD_DEFINITION
*
* type Query {
* greeting: String @upper
* }
* `);
*
* schema.getDirectives().map((directive) => directive.name); // => ['include', 'skip', 'deprecated', 'specifiedBy', 'oneOf', 'upper']
* ```
*/
getDirectives(): ReadonlyArray<GraphQLDirective>;
/**
* Returns the current directive definition.
* @param name - The GraphQL name to look up.
* @returns The current directive definition, if known.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* directive @upper on FIELD_DEFINITION
*
* type Query {
* greeting: String @upper
* }
* `);
*
* schema.getDirective('upper')?.name; // => 'upper'
* schema.getDirective('missing'); // => undefined
* ```
*/
getDirective(name: string): Maybe<GraphQLDirective>;
/**
* This method looks up the field on the given type definition.
* It has special casing for the three introspection fields, `__schema`,
* `__type` and `__typename`.
*
* `__typename` is special because it can always be queried as a field, even
* in situations where no other fields are allowed, like on a Union.
*
* `__schema` and `__type` could get automatically added to the query type,
* but that would require mutating type definitions, which would cause issues.
* @param parentType - Composite type to look up the field on.
* @param fieldName - Field name to look up.
* @returns The field definition, including supported introspection fields.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const queryType = schema.getQueryType();
*
* schema.getField(queryType, 'greeting')?.name; // => 'greeting'
* schema.getField(queryType, '__typename')?.name; // => '__typename'
* schema.getField(queryType, 'missing'); // => undefined
* ```
*/
getField(parentType: GraphQLCompositeType, fieldName: string): GraphQLField<unknown, unknown> | undefined;
/**
* Returns a normalized configuration object for this object.
*
* The returned config preserves the original `assumeValid` flag so the schema
* can be recreated with the same validation behavior.
* @returns A configuration object that can be used to recreate this object.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { GraphQLSchema } from 'graphql/type';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* const config = schema.toConfig();
* const schemaCopy = new GraphQLSchema(config);
*
* config.query?.name; // => 'Query'
* schemaCopy.getQueryType()?.name; // => 'Query'
* ```
*/
toConfig(): GraphQLSchemaNormalizedConfig;
}
type TypeMap = ObjMap<GraphQLNamedType>;
interface GraphQLSchemaValidationOptions {
/**
* When building a schema from a GraphQL service's introspection result, it
* might be safe to assume the schema is valid. Set to true to assume the
* produced schema is valid.
*
* Default: false
*
* @internal
*/
assumeValid?: boolean | undefined;
}
/** Configuration used to construct a GraphQLSchema. */
export interface GraphQLSchemaConfig extends GraphQLSchemaValidationOptions {
/** Human-readable description for this schema element, if provided. */
description?: Maybe<string>;
/** Root object type for query operations. */
query?: Maybe<GraphQLObjectType>;
/** Root object type for mutation operations. */
mutation?: Maybe<GraphQLObjectType>;
/** Root object type for subscription operations. */
subscription?: Maybe<GraphQLObjectType>;
/** Object types that belong to this union type. */
types?: Maybe<ReadonlyArray<GraphQLNamedType>>;
/** Directives available in this schema or applied to this AST node. */
directives?: Maybe<ReadonlyArray<GraphQLDirective>>;
/** Custom extension fields reserved for users. */
extensions?: Maybe<Readonly<GraphQLSchemaExtensions>>;
/** AST node from which this schema element was built, if available. */
astNode?: Maybe<SchemaDefinitionNode>;
/** AST extension nodes applied to this schema element. */
extensionASTNodes?: Maybe<ReadonlyArray<SchemaExtensionNode>>;
}
interface GraphQLSchemaNormalizedConfig extends GraphQLSchemaConfig {
description: Maybe<string>;
types: ReadonlyArray<GraphQLNamedType>;
directives: ReadonlyArray<GraphQLDirective>;
extensions: Readonly<GraphQLSchemaExtensions>;
extensionASTNodes: ReadonlyArray<SchemaExtensionNode>;
assumeValid: boolean;
}
/**
* Error thrown when GraphQL execution is aborted.
* @typeParam TResult - Result value type.
*/
export declare class AbortedGraphQLExecutionError<TResult> extends Error {
/** Partial execution result available when execution was aborted. */
readonly abortedResult: PromiseOrValue<TResult>;
/**
* Creates an error for an aborted GraphQL execution.
* @param reason - Abort reason used as the error cause.
* @param result - Partial execution result available when execution stopped.
* @example
* ```ts
* import { AbortedGraphQLExecutionError } from 'graphql/execution';
*
* const cause = new Error('Request cancelled.');
* const partialResult = { data: { viewer: null } };
* const error = new AbortedGraphQLExecutionError(cause, partialResult);
*
* error.message; // => 'Request cancelled.'
* error.cause; // => cause
* error.abortedResult; // => partialResult
* ```
*/
constructor(reason: unknown, result: PromiseOrValue<TResult>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
}
/** Arguments accepted by execute and executeSync. */
export interface ExecutionArgs {
/** The schema used for validation or execution. */
schema: GraphQLSchema;
/** The parsed GraphQL document to execute. */
document: DocumentNode;
/** Initial root value passed to the operation. */
rootValue?: unknown;
/** Application context value passed to every resolver. */
contextValue?: unknown;
/** Runtime variable values keyed by variable name. */
variableValues?: Maybe<{
readonly [variable: string]: unknown;
}>;
/** Name of the operation to execute when the document contains multiple operations. */
operationName?: Maybe<string>;
/** Resolver used when a field does not define its own resolver. */
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
/** Resolver used when an abstract type does not define its own resolver. */
typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
/** Resolver used for the root subscription field. */
subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
/** Whether suggestion text should be omitted from request errors. */
hideSuggestions?: Maybe<boolean>;
/** AbortSignal used to cancel execution. */
abortSignal?: Maybe<AbortSignal>;
/** Whether incremental execution may begin eligible work early. */
enableEarlyExecution?: Maybe<boolean>;
/** Execution hooks invoked during this operation. */
hooks?: Maybe<ExecutionHooks>;
/** Additional execution options. */
options?: {
/**
* Set the maximum number of errors allowed for coercing (defaults to 50).
*
* @internal
*/
maxCoercionErrors?: number;
};
}
/**
* Data that must be available at all points during query execution.
*
* Namely, schema of the type system that is currently executing,
* and the fragments defined in the query document
*/
export interface ValidatedExecutionArgs {
/** Schema used for execution. */
schema: GraphQLSchema;
/** Parsed GraphQL document being executed. */
document: DocumentNode;
/** Fragment definitions keyed by fragment name. */
fragmentDefinitions: ObjMap<FragmentDefinitionNode>;
/** Fragment details keyed by fragment name. */
fragments: ObjMap<FragmentDetails>;
/** Root value passed to the operation. */
rootValue: unknown;
/** Application context value passed to every resolver. */
contextValue: unknown;
/** Operation definition selected for execution. */
operation: OperationDefinitionNode;
/** Operation variable values with source metadata and coerced runtime values. */
variableValues: VariableValues;
/** Raw variable values provided by the caller before coercion. */
rawVariableValues: Maybe<{
readonly [variable: string]: unknown;
}>;
/** Resolver used for fields without an explicit resolver. */
fieldResolver: GraphQLFieldResolver<any, any>;
/** Resolver used for abstract types without an explicit type resolver. */
typeResolver: GraphQLTypeResolver<any, any>;
/** Resolver used for subscription fields without an explicit subscribe resolver. */
subscribeFieldResolver: GraphQLFieldResolver<any, any>;
/** Whether suggestion text should be omitted from execution errors. */
hideSuggestions: boolean;
/** Whether execution should use error propagation. */
errorPropagation: boolean;
/** External signal that may abort execution. */
externalAbortSignal: AbortSignal | undefined;
/** Whether incremental execution may begin eligible work early. */
enableEarlyExecution: boolean;
/** Execution hooks supplied by the caller. */
hooks: ExecutionHooks | undefined;
}
/** Validated execution arguments for a subscription operation. */
export interface ValidatedSubscriptionArgs extends ValidatedExecutionArgs {
/** Subscription operation definition selected for execution. */
operation: SubscriptionOperationDefinitionNode;
}
/** Information passed to hooks after asynchronous execution work has finished. */
export interface AsyncWorkFinishedInfo {
/** Validated execution arguments for the operation that finished async work. */
validatedExecutionArgs: ValidatedExecutionArgs;
}
/** Optional hooks invoked during GraphQL execution. */
export interface ExecutionHooks {
/** Called after all tracked asynchronous execution work has settled. */
asyncWorkFinished?: (info: AsyncWorkFinishedInfo) => void;
}
/**
* Represents the response produced by executing a GraphQL operation.
* @typeParam TData - Shape of the execution data payload.
* @typeParam TExtensions - Shape of the extensions payload.
*/
export interface ExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
/** Errors raised while parsing, validating, or executing the operation. */
errors?: ReadonlyArray<GraphQLError>;
/** Data returned by execution, or null when execution could not produce data. */
data?: TData | null;
/** Additional non-standard metadata included in the execution result. */
extensions?: TExtensions;
}
/**
* A JSON-serializable GraphQL execution result.
* @typeParam TData - Shape of the formatted data payload.
* @typeParam TExtensions - Shape of the formatted extensions payload.
*/
export interface FormattedExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
/** Errors raised while parsing, validating, or executing the operation. */
errors?: ReadonlyArray<GraphQLFormattedError>;
/** Data returned by execution, or null when execution could not produce data. */
data?: TData | null;
/** Additional non-standard metadata included in the formatted result. */
extensions?: TExtensions;
}
/**
* Results for an operation that produced incremental payloads.
* @typeParam TInitialData - Shape of the initial result data payload.
* @typeParam TDeferredData - Shape of deferred fragment data payloads.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export interface ExperimentalIncrementalExecutionResults<TInitialData = ObjMap<unknown>, TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Initial execution result delivered before subsequent incremental payloads. */
initialResult: InitialIncrementalExecutionResult<TInitialData, TExtensions>;
/** Async stream of incremental payloads delivered after the initial result. */
subsequentResults: AsyncGenerator<SubsequentIncrementalExecutionResult<TDeferredData, TStreamItem, TExtensions>, void, void>;
}
/**
* JSON-serializable form of incremental execution results.
* @typeParam TInitial - Shape of the formatted initial result data payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data payloads.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedExperimentalIncrementalExecutionResults<TInitial = ObjMap<unknown>, TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Formatted initial execution result. */
initialResult: FormattedInitialIncrementalExecutionResult<TInitial, TExtensions>;
/** Async stream of formatted incremental payloads. */
subsequentResults: AsyncGenerator<FormattedSubsequentIncrementalExecutionResult<TDeferredData, TStreamItem, TExtensions>, void, void>;
}
/**
* Initial execution result for an operation that produced incremental payloads.
* @typeParam TData - Shape of the initial data payload.
* @typeParam TExtensions - Shape of the extensions payload.
*/
export interface InitialIncrementalExecutionResult<TData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> extends ExecutionResult<TData, TExtensions> {
/** Data produced by the initial execution payload. */
data: TData;
/** Incremental payloads that are still pending after the initial result. */
pending: ReadonlyArray<PendingResult>;
/** Indicates that subsequent incremental payloads will follow. */
hasNext: true;
/** Additional non-standard metadata included in the initial result. */
extensions?: TExtensions;
}
/**
* JSON-serializable form of an initial incremental execution result.
* @typeParam TInitialData - Shape of the formatted initial data payload.
* @typeParam TExtensions - Shape of the formatted extensions payload.
*/
export interface FormattedInitialIncrementalExecutionResult<TInitialData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> extends FormattedExecutionResult<TInitialData, TExtensions> {
/** Formatted data produced by the initial execution payload. */
data: TInitialData;
/** Formatted list of incremental payloads still pending after the initial result. */
pending: ReadonlyArray<PendingResult>;
/** Indicates whether subsequent incremental payloads will follow. */
hasNext: boolean;
/** Additional non-standard metadata included in the formatted initial result. */
extensions?: TExtensions;
}
/**
* Subsequent payload produced by incremental execution.
* @typeParam TDeferredData - Shape of deferred fragment data payloads.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of the extensions payload.
*/
export interface SubsequentIncrementalExecutionResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Incremental payloads that became pending with this response. */
pending?: ReadonlyArray<PendingResult>;
/** Deferred or streamed payloads delivered by this response. */
incremental?: ReadonlyArray<IncrementalResult<TDeferredData, TStreamItem, TExtensions>>;
/** Incremental payloads that completed with this response. */
completed?: ReadonlyArray<CompletedResult>;
/** Indicates whether more incremental payloads will follow. */
hasNext: boolean;
/** Additional non-standard metadata included in this payload. */
extensions?: TExtensions;
}
/**
* JSON-serializable form of a subsequent incremental execution payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data payloads.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedSubsequentIncrementalExecutionResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Indicates whether more incremental payloads will follow. */
hasNext: boolean;
/** Formatted incremental payloads that became pending with this response. */
pending?: ReadonlyArray<PendingResult>;
/** Formatted deferred or streamed payloads delivered by this response. */
incremental?: ReadonlyArray<FormattedIncrementalResult<TDeferredData, TStreamItem, TExtensions>>;
/** Formatted incremental payloads that completed with this response. */
completed?: ReadonlyArray<FormattedCompletedResult>;
/** Additional non-standard metadata included in this formatted payload. */
extensions?: TExtensions;
}
/**
* Incremental payload produced by a deferred fragment.
* @typeParam TDeferredData - Shape of deferred fragment data.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export interface IncrementalDeferResult<TDeferredData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
/** Identifier matching this payload to a pending deferred fragment. */
id: string;
/** Path from the deferred fragment location to this payload. */
subPath?: ReadonlyArray<string | number>;
/** Errors raised while executing the deferred fragment. */
errors?: ReadonlyArray<GraphQLError>;
/** Data produced by the deferred fragment. */
data: TDeferredData;
/** Additional non-standard metadata included in this payload. */
extensions?: TExtensions;
}
/**
* JSON-serializable form of a deferred fragment payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedIncrementalDeferResult<TDeferredData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> {
/** Formatted errors raised while executing the deferred fragment. */
errors?: ReadonlyArray<GraphQLFormattedError>;
/** Formatted data produced by the deferred fragment. */
data: TDeferredData;
/** Identifier matching this payload to a pending deferred fragment. */
id: string;
/** Path from the deferred fragment location to this payload. */
subPath?: ReadonlyArray<string | number>;
/** Additional non-standard metadata included in this formatted payload. */
extensions?: TExtensions;
}
/**
* Incremental payload produced by a streamed list field.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export interface IncrementalStreamResult<TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Identifier matching this payload to a pending stream. */
id: string;
/** Path from the streamed field location to these items. */
subPath?: ReadonlyArray<string | number>;
/** Errors raised while producing streamed items. */
errors?: ReadonlyArray<GraphQLError>;
/** Streamed list items delivered by this payload. */
items: ReadonlyArray<TStreamItem>;
/** Additional non-standard metadata included in this payload. */
extensions?: TExtensions;
}
/**
* JSON-serializable form of a streamed list payload.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedIncrementalStreamResult<TStreamItem = Array<unknown>, TExtensions = ObjMap<unknown>> {
/** Formatted errors raised while producing streamed items. */
errors?: ReadonlyArray<GraphQLFormattedError>;
/** Formatted streamed list items delivered by this payload. */
items: ReadonlyArray<TStreamItem>;
/** Identifier matching this payload to a pending stream. */
id: string;
/** Path from the streamed field location to these items. */
subPath?: ReadonlyArray<string | number>;
/** Additional non-standard metadata included in this formatted payload. */
extensions?: TExtensions;
}
/**
* Deferred fragment or streamed list payload produced by incremental execution.
* @typeParam TDeferredData - Shape of deferred fragment data.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export type IncrementalResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> = IncrementalDeferResult<TDeferredData, TExtensions> | IncrementalStreamResult<TStreamItem, TExtensions>;
/**
* JSON-serializable deferred fragment or streamed list payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export type FormattedIncrementalResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> = FormattedIncrementalDeferResult<TDeferredData, TExtensions> | FormattedIncrementalStreamResult<TStreamItem, TExtensions>;
interface PendingResult {
id: string;
path: ReadonlyArray<string | number>;
label?: string;
}
interface CompletedResult {
id: string;
errors?: ReadonlyArray<GraphQLError>;
}
interface FormattedCompletedResult {
id: string;
errors?: ReadonlyArray<GraphQLFormattedError>;
}
interface MinimalChannel<TMessage = unknown> {
readonly hasSubscribers?: boolean;
publish: (message: TMessage) => void;
runStores: <T, ContextType extends object>(context: ContextType, fn: (this: ContextType, ...args: Array<unknown>) => T, thisArg?: unknown, ...args: Array<unknown>) => T;
}
interface MinimalTracingChannel<TContext = unknown> {
readonly hasSubscribers: boolean | undefined;
readonly start: MinimalChannel<TContext>;
readonly end: MinimalChannel<TContext>;
readonly asyncStart: MinimalChannel<TContext>;
readonly asyncEnd: MinimalChannel<TContext>;
readonly error: MinimalChannel<TContext>;
traceSync: <T>(fn: (...args: Array<unknown>) => T, context: TContext extends object ? TContext : object, thisArg?: unknown, ...args: Array<unknown>) => T;
}
/** Context published on the sync-only `graphql:parse` channel. */
export interface GraphQLParseContext {
/** Source text or source object passed to the parser. */
source: string | Source;
/** Error thrown while parsing, when parsing fails. */
error?: unknown;
/** Parsed document, when parsing succeeds. */
result?: DocumentNode;
}
/** Context published on the sync-only `graphql:validate` channel. */
export interface GraphQLValidateContext {
/** Schema used for validation. */
schema: GraphQLSchema;
/** Parsed document being validated. */
document: DocumentNode;
/** Error thrown while validating, when validation fails abruptly. */
error?: unknown;
/** Validation errors returned by validation. */
result?: ReadonlyArray<GraphQLError>;
}
/**
* Context published on `graphql:execute`.
*
* Returned results may contain GraphQL errors collected during execution.
*/
export interface GraphQLExecuteContext {
/** Schema used for execution. */
schema: GraphQLSchema;
/** Parsed document being executed. */
document: DocumentNode;
/** Raw variable values provided by the caller before coercion. */
rawVariableValues: Maybe<{
readonly [variable: string]: unknown;
}>;
/** Selected operation name, if one is available. */
operationName: string | undefined;
/** Selected operation type, if one is available. */
operationType: OperationTypeNode | undefined;
/** Error thrown or rejected while executing, when execution fails abruptly. */
error?: unknown;
/** Execution result returned by execution, including GraphQL errors. */
result?: ExecutionResult | ExperimentalIncrementalExecutionResults;
}
/**
* Context published on `graphql:execute:rootSelectionSet`.
*
* Returned results may contain GraphQL errors collected during execution.
*/
export interface GraphQLExecuteRootSelectionSetContext {
/** Schema used for execution. */
schema: GraphQLSchema;
/** Parsed document being executed. */
document: DocumentNode;
/** Operation definition selected for execution. */
operation: OperationDefinitionNode;
/** Raw variable values provided by the caller before coercion. */
rawVariableValues: Maybe<{
readonly [variable: string]: unknown;
}>;
/** Selected operation name, if one is available. */
operationName: string | undefined;
/** Selected operation type. */
operationType: OperationTypeNode;
/** Error thrown or rejected while executing the root selection set. */
error?: unknown;
/**
* Execution result returned from the root selection set, including GraphQL
* errors.
*/
result?: ExecutionResult | ExperimentalIncrementalExecutionResults;
}
/**
* Context published on `graphql:execute:variableCoercion`.
*
* Coercion runs synchronously while execution arguments are validated, so only
* the `start`/`end` (and, on an abrupt throw, `error`) lifecycle fires.
* Ordinary variable coercion failures are returned on `result.errors`; when
* execution is invoked through APIs such as `execute()` or `subscribe()`, they
* surface as GraphQL result errors rather than as the tracing `error`
* lifecycle event.
*/
export interface GraphQLExecuteVariableCoercionContext {
/** Schema used for variable coercion. */
schema: GraphQLSchema;
/** Parsed document being executed. */
document: DocumentNode;
/** Operation definition whose variables are being coerced. */
operation: OperationDefinitionNode;
/** Raw variable values provided by the caller before coercion. */
rawVariableValues: Maybe<{
readonly [variable: string]: unknown;
}>;
/** Selected operation name, if one is available. */
operationName: string | undefined;
/** Selected operation type. */
operationType: OperationTypeNode;
/** Error thrown while coercing variables, when coercion fails abruptly. */
error?: unknown;
/** Coerced variable values or coercion errors returned by coercion. */
result?: {
variableValues: VariableValues;
} | {
errors: ReadonlyArray<GraphQLError>;
};
}
/**
* Context published on `graphql:subscribe`.
*
* Subscription source resolver errors and invalid source stream results are
* returned on `result` as ExecutionResult errors; they do not publish the
* `error` lifecycle event unless subscription setup fails abruptly before
* GraphQL can form a result.
*/
export interface GraphQLSubscribeContext {
/** Schema used for subscription execution. */
schema: GraphQLSchema;
/** Parsed subscription document. */
document: DocumentNode;
/** Raw variable values provided by the caller before coercion. */
rawVariableValues: Maybe<{
readonly [variable: string]: unknown;
}>;
/** Selected operation name, if one is available. */
operationName: string | undefined;
/** Selected operation type, if one is available. */
operationType: OperationTypeNode | undefined;
/** Error thrown or rejected while subscribing, when setup fails abruptly. */
error?: unknown;
/**
* Subscription response stream, or an ExecutionResult containing GraphQL
* errors.
*/
result?: AsyncGenerator<ExecutionResult, void, void> | ExecutionResult;
}
/**
* Context published on `graphql:resolve`.
*
* Resolver throws and rejections publish the `error` lifecycle event here.
* The same failure may also be formatted into the enclosing execution or
* subscription result.
*/
export interface GraphQLResolveContext {
/** Field name being resolved. */
fieldName: string;
/** Response alias for the field being resolved. */
alias: string;
/** Parent type name for the field being resolved. */
parentType: string;
/** Return type string for the field being resolved. */
fieldType: string;
/** Argument values passed to the resolver. */
args: ObjMap<unknown>;
/** Whether the field is using the default resolver. */
isDefaultResolver: boolean;
/** Response path for the field being resolved. */
fieldPath: string;
/** Error thrown or rejected by the resolver, when resolution fails. */
error?: unknown;
/** Value returned by the resolver, when resolution succeeds. */
result?: unknown;
}
/** Mapping from tracing channel name to the context type published on it. */
export interface GraphQLChannelContextByName {
/** Context published on `graphql:parse`. */
"graphql:parse": GraphQLParseContext;
/** Context published on `graphql:validate`. */
"graphql:validate": GraphQLValidateContext;
/** Context published on `graphql:execute`. */
"graphql:execute": GraphQLExecuteContext;
/** Context published on `graphql:execute:variableCoercion`. */
"graphql:execute:variableCoercion": GraphQLExecuteVariableCoercionContext;
/** Context published on `graphql:execute:rootSelectionSet`. */
"graphql:execute:rootSelectionSet": GraphQLExecuteRootSelectionSetContext;
/** Context published on `graphql:subscribe`. */
"graphql:subscribe": GraphQLSubscribeContext;
/** Context published on `graphql:resolve`. */
"graphql:resolve": GraphQLResolveContext;
}
/**
* The collection of tracing channels GraphQL.js emits on. Application
* performance monitoring (APM) tools subscribe to these by name on their own
* `node:diagnostics_channel` import; both paths land on the same channel
* instance because `tracingChannel(name)` is cached by name.
*/
export interface GraphQLChannels {
/** Tracing channel for `graphql:execute`. */
execute: MinimalTracingChannel<GraphQLExecuteContext>;
/** Tracing channel for `graphql:execute:variableCoercion`. */
executeVariableCoercion: MinimalTracingChannel<GraphQLExecuteVariableCoercionContext>;
/** Tracing channel for `graphql:execute:rootSelectionSet`. */
executeRootSelectionSet: MinimalTracingChannel<GraphQLExecuteRootSelectionSetContext>;
/** Tracing channel for `graphql:parse`. */
parse: MinimalTracingChannel<GraphQLParseContext>;
/** Tracing channel for `graphql:validate`. */
validate: MinimalTracingChannel<GraphQLValidateContext>;
/** Tracing channel for `graphql:resolve`. */
resolve: MinimalTracingChannel<GraphQLResolveContext>;
/** Tracing channel for `graphql:subscribe`. */
subscribe: MinimalTracingChannel<GraphQLSubscribeContext>;
}
interface LexerInterface {
source: Source;
lastToken: Token;
token: Token;
line: number;
lineStart: number;
advance: () => Token;
lookahead: () => Token;
}
/**
* Given a Source object, creates a Lexer for that source.
* A Lexer is a stateful stream generator in that every time
* it is advanced, it returns the next token in the Source. Assuming the
* source lexes, the final Token emitted by the lexer will be of kind
* EOF, after which the lexer will repeatedly return the same EOF token
* whenever called.
*/
export declare class Lexer implements LexerInterface {
/** Source document used to derive error locations. */
source: Source;
/** Most recent non-ignored token returned by the lexer. */
lastToken: Token;
/** Current non-ignored token at the lexer cursor. */
token: Token;
/** The (1-indexed) line containing the current token. */
line: number;
/** Character offset where the current line starts. */
lineStart: number;
/**
* Creates a Lexer instance.
* @param source - Source document used to derive error locations.
* @example
* ```ts
* import { Lexer, Source, TokenKind } from 'graphql/language';
*
* const lexer = new Lexer(new Source('{ hello }'));
*
* lexer.token.kind; // => TokenKind.SOF
* lexer.advance().kind; // => TokenKind.BRACE_L
* lexer.advance().value; // => 'hello'
* lexer.advance().kind; // => TokenKind.BRACE_R
* ```
*/
constructor(source: Source);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Advances the token stream to the next non-ignored token.
* @returns The next non-ignored token.
* @example
* ```ts
* import { Lexer, Source } from 'graphql/language';
*
* const lexer = new Lexer(new Source('{ hello }'));
* const token = lexer.advance();
*
* token.kind; // => '{'
* lexer.token; // => token
* ```
*/
advance(): Token;
/**
* Looks ahead and returns the next non-ignored token, but does not change
* the state of Lexer.
* @returns The next non-ignored token without advancing the lexer.
* @example
* ```ts
* import { Lexer, Source } from 'graphql/language';
*
* const lexer = new Lexer(new Source('{ hello }'));
* const token = lexer.lookahead();
*
* token.kind; // => '{'
* lexer.token.kind; // => '<SOF>'
* ```
*/
lookahead(): Token;
}
/** Configuration options to control parser behavior */
export interface ParseOptions {
/**
* By default, the parser creates AST nodes that know the location
* in the source that they correspond to. This configuration flag
* disables that behavior for performance or testing.
*/
noLocation?: boolean | undefined;
/**
* Parser CPU and memory usage is linear to the number of tokens in a document
* however in extreme cases it becomes quadratic due to memory exhaustion.
* Parsing happens before validation so even invalid queries can burn lots of
* CPU time and memory.
* To prevent this you can set a maximum number of tokens allowed within a document.
*/
maxTokens?: number | undefined;
/**
* EXPERIMENTAL:
*
* If enabled, the parser will understand and parse fragment variable definitions
* and arguments on fragment spreads. Fragment variable definitions will be represented
* in the `variableDefinitions` field of the FragmentDefinitionNode.
* Fragment spread arguments will be represented in the `arguments` field of FragmentSpreadNode.
* @example
* ```graphql prettier-ignore
* {
* t { ...A(var: true) }
* }
* fragment A($var: Boolean = false) on T {
* ...B(x: $var)
* }
* ```
*/
experimentalFragmentArguments?: boolean | undefined;
/**
* Internal parser hook for GraphQL.js entry points that need to parse a
* restricted grammar with an alternate lexer.
* @internal
*/
lexer?: LexerInterface | undefined;
}
/**
* Given a GraphQL source, parses it into a Document.
* Throws GraphQLError if a syntax error is encountered.
* @param source - A GraphQL source string or source object.
* @param options - Optional parser configuration.
* @returns The parsed GraphQL document AST.
* @example
* ```ts
* // Parse a GraphQL document with the default parser options.
* import { parse } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
*
* document.kind; // => 'Document'
* ```
* @example
* ```ts
* // This variant enables parser options and provides an explicit lexer.
* import { Lexer, Source, parse } from 'graphql/language';
*
* const document = parse(
* `
* {
* t { ...A(var: true) }
* }
* fragment A($var: Boolean = false) on T {
* name
* }
* `,
* {
* experimentalFragmentArguments: true,
* maxTokens: 80,
* noLocation: true,
* },
* );
* const directiveDocument = parse('directive @foo @bar on FIELD');
* const source = new Source('{ hero }');
* const lexerDocument = parse(source, { lexer: new Lexer(source) });
*
* document.definitions[0].kind; // => 'OperationDefinition'
* document.definitions[1].kind; // => 'FragmentDefinition'
* document.loc; // => undefined
* directiveDocument.definitions[0].kind; // => 'DirectiveDefinition'
* lexerDocument.definitions[0].kind; // => 'OperationDefinition'
* ```
*/
export declare function parse(source: string | Source, options?: ParseOptions): DocumentNode;
/**
* Given a string containing a GraphQL value (ex. `[42]`), parse the AST for
* that value.
* Throws GraphQLError if a syntax error is encountered.
*
* This is useful within tools that operate upon GraphQL Values directly and
* in isolation of complete GraphQL documents.
*
* Consider providing the results to the utility function: valueFromAST().
* @param source - A GraphQL source string or source object containing a value.
* @param options - Optional parser configuration.
* @returns The parsed GraphQL value AST.
* @example
* ```ts
* import { parseValue } from 'graphql/language';
*
* const value = parseValue('[42]');
*
* value.kind; // => 'ListValue'
* ```
*/
export declare function parseValue(source: string | Source, options?: ParseOptions): ValueNode;
/**
* Similar to parseValue(), but raises a parse error if it encounters a
* variable. The return type will be a constant value.
* @param source - A GraphQL source string or source object containing a constant value.
* @param options - Optional parser configuration.
* @returns The parsed GraphQL constant value AST.
* @example
* ```ts
* import { parseConstValue } from 'graphql/language';
*
* const value = parseConstValue('{ enabled: true }');
*
* value.kind; // => 'ObjectValue'
* parseConstValue('$variable'); // throws an error
* ```
*/
export declare function parseConstValue(source: string | Source, options?: ParseOptions): ConstValueNode;
/**
* Given a string containing a GraphQL Type (ex. `[Int!]`), parse the AST for
* that type.
* Throws GraphQLError if a syntax error is encountered.
*
* This is useful within tools that operate upon GraphQL Types directly and
* in isolation of complete GraphQL documents.
*
* Consider providing the results to the utility function: typeFromAST().
* @param source - A GraphQL source string or source object containing a type reference.
* @param options - Optional parser configuration.
* @returns The parsed GraphQL type AST.
* @example
* ```ts
* import { parseType } from 'graphql/language';
*
* const type = parseType('[String!]');
*
* type.kind; // => 'ListType'
* ```
*/
export declare function parseType(source: string | Source, options?: ParseOptions): TypeNode;
/**
* Given a string containing a GraphQL Schema Coordinate (ex. `Type.field`),
* parse the AST for that schema coordinate.
* Throws GraphQLError if a syntax error is encountered.
*
* Consider providing the results to the utility function:
* resolveASTSchemaCoordinate(). Or calling resolveSchemaCoordinate() directly
* with an unparsed source.
* @param source - A GraphQL source string or source object containing a schema coordinate.
* @returns The parsed GraphQL schema coordinate AST.
* @example
* ```ts
* import { parseSchemaCoordinate } from 'graphql/language';
*
* const coordinate = parseSchemaCoordinate('Query.hero');
*
* coordinate.kind; // => 'MemberCoordinate'
* ```
*/
export declare function parseSchemaCoordinate(source: string | Source): SchemaCoordinateNode;
/** The set of allowed kind values for AST nodes. */
export type Kind = (typeof Kind)[keyof typeof Kind];
/** A visitor defines the callbacks called during AST traversal. */
export type ASTVisitor = EnterLeaveVisitor<ASTNode> | KindVisitor;
type KindVisitor = {
readonly [NodeT in ASTNode as NodeT["kind"]]?: ASTVisitFn<NodeT> | EnterLeaveVisitor<NodeT>;
};
interface EnterLeaveVisitor<TVisitedNode extends ASTNode> {
readonly enter?: ASTVisitFn<TVisitedNode> | undefined;
readonly leave?: ASTVisitFn<TVisitedNode> | undefined;
}
/**
* A visitor is composed of visit functions called for each node during traversal.
* @typeParam TVisitedNode - AST node type handled by this visitor function.
*/
export type ASTVisitFn<TVisitedNode extends ASTNode> = (
/** Current node being visited. */
node: TVisitedNode,
/** Index or key for this node within the parent node or array. */
key: string | number | undefined,
/** Parent immediately above this node, which may be an array. */
parent: ASTNode | ReadonlyArray<ASTNode> | undefined,
/** Key path from the root node to this node. */
path: ReadonlyArray<string | number>,
/**
* All nodes and arrays visited before reaching this node's parent.
* These correspond to array indices in `path`.
* Note: ancestors includes arrays that contain the visited node's parent.
*/
ancestors: ReadonlyArray<ASTNode | ReadonlyArray<ASTNode>>) => any;
type ASTReducer<R> = {
readonly [NodeT in ASTNode as NodeT["kind"]]?: {
readonly enter?: ASTVisitFn<NodeT>;
readonly leave: ASTReducerFn<NodeT, R>;
};
};
type ASTReducerFn<TReducedNode extends ASTNode, R> = (
/**
* Current node being visited.
* @internal
*/
node: {
[K in keyof TReducedNode]: ReducedField<TReducedNode[K], R>;
},
/**
* Index or key for this node within the parent node or array.
* @internal
*/
key: string | number | undefined,
/**
* Parent immediately above this node, which may be an array.
* @internal
*/
parent: ASTNode | ReadonlyArray<ASTNode> | undefined,
/**
* Key path from the root node to this node.
* @internal
*/
path: ReadonlyArray<string | number>,
/**
* All nodes and arrays visited before reaching this node's parent.
* These correspond to array indices in `path`.
* Note: ancestors includes arrays that contain the visited node's parent.
* @internal
*/
ancestors: ReadonlyArray<ASTNode | ReadonlyArray<ASTNode>>) => R;
type ReducedField<T, R> = T extends ASTNode ? R : T extends ReadonlyArray<ASTNode> ? ReadonlyArray<R> : T;
/** A visitor key map describes the traversable child properties for each node kind. */
export type ASTVisitorKeyMap = {
[NodeT in ASTNode as NodeT["kind"]]?: ReadonlyArray<keyof NodeT>;
};
/** A value that can be returned from a visitor function to stop traversal. */
export declare const BREAK: unknown;
/**
* visit() will walk through an AST using a depth-first traversal, calling
* the visitor's enter function at each node in the traversal, and calling the
* leave function after visiting that node and all of its child nodes.
*
* By returning different values from the enter and leave functions, the
* behavior of the visitor can be altered, including skipping over a sub-tree of
* the AST (by returning false), editing the AST by returning a value or null
* to remove the value, or to stop the whole traversal by returning BREAK.
*
* When using visit() to edit an AST, the original AST will not be modified, and
* a new version of the AST with the changes applied will be returned from the
* visit function.
* @param root - The AST node at which to start traversal.
* @param visitor - The visitor or reducer functions to call while traversing.
* @param visitorKeys - Optional map of child keys to visit for each AST node kind.
* @returns The original AST, an edited AST, or a reduced value depending on the visitor.
* @typeParam N - The root AST node type returned when visiting without reducing.
* @example
* ```ts
* // Return values control traversal: undefined makes no change, false skips
* // a subtree, BREAK stops traversal, null removes a node, and any other
* // value replaces the current node.
* import { Kind, parse, print, visit } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
* const editedAST = visit(document, {
* Field: (node) => {
* if (node.name.value === 'hero') {
* return {
* ...node,
* name: { kind: Kind.NAME, value: 'human' },
* };
* }
* },
* });
*
* print(editedAST); // => '{\n human {\n name\n }\n}'
* ```
* @example
* ```ts
* // A named visitor function runs when entering nodes of that kind.
* import { parse, visit } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
* const fieldNames = [];
*
* visit(document, {
* Field: (node) => {
* fieldNames.push(node.name.value);
* },
* });
*
* fieldNames; // => ['hero', 'name']
* ```
* @example
* ```ts
* // A named visitor object can provide separate enter and leave handlers for
* // nodes of that kind.
* import { parse, visit } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
* const events = [];
*
* visit(document, {
* Field: {
* enter: (node) => {
* events.push(`enter:${node.name.value}`);
* },
* leave: (node) => {
* events.push(`leave:${node.name.value}`);
* },
* },
* });
*
* events; // => ['enter:hero', 'enter:name', 'leave:name', 'leave:hero']
* ```
* @example
* ```ts
* // Generic enter and leave handlers run for every node.
* import { parse, visit } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
* let enterCount = 0;
* let leaveCount = 0;
*
* visit(document, {
* enter: (node) => {
* enterCount += 1;
* },
* leave: (node) => {
* leaveCount += 1;
* },
* });
*
* enterCount; // => leaveCount
* enterCount > 0; // => true
* ```
*/
export declare function visit<N extends ASTNode>(root: N, visitor: ASTVisitor, visitorKeys?: ASTVisitorKeyMap): N;
/**
* Traverses an AST with reducer callbacks and returns the reduced value.
* @param root - The AST node where traversal starts.
* @param visitor - Reducer callbacks to invoke during traversal.
* @param visitorKeys - Optional mapping of child keys for each AST node kind.
* @returns The value produced by the reducer visitor.
* @typeParam R - The value produced by reducer visitor callbacks.
* @example
* ```ts
* // A reducer visitor returns values from leave handlers to build a reduced
* // result instead of returning an edited AST.
* import { parse, visit } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
* const printed = visit(document, {
* Name: {
* leave: (node) => {
* return node.value;
* },
* },
* Field: {
* leave: (node) => {
* return node.selectionSet == null
* ? node.name
* : `${node.name} { ${node.selectionSet} }`;
* },
* },
* SelectionSet: {
* leave: (node) => {
* return node.selections.join(' ');
* },
* },
* OperationDefinition: {
* leave: (node) => {
* return node.selectionSet;
* },
* },
* Document: {
* leave: (node) => {
* return node.definitions.join('\n');
* },
* },
* });
*
* printed; // => 'hero { name }'
* ```
*/
export declare function visit<R>(root: ASTNode, visitor: ASTReducer<R>, visitorKeys?: ASTVisitorKeyMap): R;
/**
* Creates a new visitor instance which delegates to many visitors to run in
* parallel. Each visitor will be visited for each node before moving on.
*
* If a prior visitor edits a node, no following visitors will see that node.
* @param visitors - The visitors to merge into one parallel visitor.
* @returns A visitor that delegates traversal to each provided visitor.
* @example
* ```ts
* import { parse, visit, visitInParallel } from 'graphql/language';
*
* const document = parse('{ hero { name } }');
* const events = [];
*
* visit(
* document,
* visitInParallel([
* {
* Field: (node) => {
* events.push(`field:${node.name.value}`);
* },
* },
* {
* Name: (node) => {
* events.push(`name:${node.value}`);
* },
* },
* ]),
* );
*
* events; // => ['field:hero', 'name:hero', 'field:name', 'name:name']
* ```
*/
export declare function visitInParallel(visitors: ReadonlyArray<ASTVisitor>): ASTVisitor;
/**
* Given a visitor instance and a node kind, return EnterLeaveVisitor for that kind.
* @param visitor - The visitor object to inspect.
* @param kind - The AST node kind to resolve handlers for.
* @returns The enter and leave handlers that apply for the given node kind.
* @example
* ```ts
* import { Kind, getEnterLeaveForKind } from 'graphql/language';
*
* const handlers = getEnterLeaveForKind({ Field: () => {} }, Kind.FIELD);
*
* typeof handlers.enter; // => 'function'
* handlers.leave; // => undefined
* ```
*/
export declare function getEnterLeaveForKind(visitor: ASTVisitor, kind: Kind): EnterLeaveVisitor<ASTNode>;
interface FragmentSignature {
readonly definition: FragmentDefinitionNode;
readonly variableDefinitions: Map<string, VariableDefinitionNode>;
}
/**
* TypeInfo is a utility class which, given a GraphQL schema, can keep track
* of the current field and type definitions at any point in a GraphQL document
* AST during a recursive descent by calling `enter(node)` and `leave(node)`.
*/
export declare class TypeInfo {
private _schema;
private _typeStack;
private _parentTypeStack;
private _inputTypeStack;
private _fieldDefStack;
private _defaultValueStack;
private _directive;
private _argument;
private _enumValue;
private _fragmentSignaturesByName;
private _fragmentSignature;
private _fragmentArgument;
/**
* Creates a TypeInfo instance.
* @param schema - Schema used for type lookups.
* @param initialType - Optional type to use at the start of traversal.
* @param fragmentSignatures - Fragment signatures available during traversal.
* @example
* ```ts
* // Track field types during a visitWithTypeInfo traversal.
* import { parse, visit } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const typeInfo = new TypeInfo(schema);
* const seenTypes = [];
*
* visit(
* parse('{ greeting }'),
* visitWithTypeInfo(typeInfo, {
* Field: () => {
* seenTypes.push(String(typeInfo.getType()));
* },
* }),
* );
*
* seenTypes; // => ['String']
* ```
* @example
* ```ts
* // This variant starts from an initial type and supplies fragment signatures.
* import { Kind, parse } from 'graphql/language';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String): String
* }
* `);
* const fragmentDocument = parse(
* 'fragment GreetingFields($name: String) on Query { greeting(name: $name) }',
* { experimentalFragmentArguments: true },
* );
* const fragmentDefinition = fragmentDocument.definitions[0];
* const variableDefinition = fragmentDefinition.variableDefinitions[0];
* const typeInfo = new TypeInfo(schema, schema.getQueryType(), (name) =>
* name === 'GreetingFields'
* ? {
* definition: fragmentDefinition,
* variableDefinitions: new Map([['name', variableDefinition]]),
* }
* : undefined,
* );
*
* typeInfo.enter({
* kind: Kind.SELECTION_SET,
* selections: [],
* });
* typeInfo.enter({
* kind: Kind.FRAGMENT_SPREAD,
* name: { kind: Kind.NAME, value: 'GreetingFields' },
* arguments: [],
* directives: [],
* });
*
* String(typeInfo.getParentType()); // => 'Query'
* typeInfo.getFragmentSignature()?.definition.name.value; // => 'GreetingFields'
* ```
*/
constructor(schema: GraphQLSchema,
/**
* Initial type may be provided in rare cases to facilitate traversals
* beginning somewhere other than documents.
*/
initialType?: Maybe<GraphQLType>, fragmentSignatures?: Maybe<(fragmentName: string) => Maybe<FragmentSignature>>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns the current output type at this point in traversal.
* @returns The current output type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* viewer: User
* }
*
* type User {
* name: String
* }
* `);
* const typeInfo = new TypeInfo(schema);
* const fieldTypes = {};
*
* visit(
* parse('{ viewer { name } }'),
* visitWithTypeInfo(typeInfo, {
* Field: (node) => {
* fieldTypes[node.name.value] = String(typeInfo.getType());
* },
* }),
* );
*
* fieldTypes; // => { viewer: 'User', name: 'String' }
* ```
*/
getType(): Maybe<GraphQLOutputType>;
/**
* Returns the current parent composite type.
* @returns The current parent composite type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* viewer: User
* }
*
* type User {
* name: String
* }
* `);
* const typeInfo = new TypeInfo(schema);
* const parentTypes = {};
*
* visit(
* parse('{ viewer { name } }'),
* visitWithTypeInfo(typeInfo, {
* Field: (node) => {
* parentTypes[node.name.value] = String(typeInfo.getParentType());
* },
* }),
* );
*
* parentTypes; // => { viewer: 'Query', name: 'User' }
* ```
*/
getParentType(): Maybe<GraphQLCompositeType>;
/**
* Returns the current input type at this point in traversal.
* @returns The current input type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* reviews(stars: Int!, sort: Sort = NEWEST): [String]
* }
*
* enum Sort {
* NEWEST
* OLDEST
* }
* `);
* const typeInfo = new TypeInfo(schema);
* const inputTypes = {};
*
* visit(
* parse('{ reviews(stars: 5, sort: OLDEST) }'),
* visitWithTypeInfo(typeInfo, {
* Argument: (node) => {
* inputTypes[node.name.value] = String(typeInfo.getInputType());
* },
* }),
* );
*
* inputTypes; // => { stars: 'Int!', sort: 'Sort' }
* ```
*/
getInputType(): Maybe<GraphQLInputType>;
/**
* Returns the parent input type for the current input position.
* @returns The parent input type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* input ReviewFilter {
* stars: Int!
* }
*
* type Query {
* reviews(filter: ReviewFilter): [String]
* }
* `);
* const typeInfo = new TypeInfo(schema);
* const parentInputTypes = {};
*
* visit(
* parse('{ reviews(filter: { stars: 5 }) }'),
* visitWithTypeInfo(typeInfo, {
* ObjectField: (node) => {
* parentInputTypes[node.name.value] = String(typeInfo.getParentInputType());
* },
* }),
* );
*
* parentInputTypes; // => { stars: 'ReviewFilter' }
* ```
*/
getParentInputType(): Maybe<GraphQLInputType>;
/**
* Returns the current field definition.
* @returns The current field definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const typeInfo = new TypeInfo(schema);
* let fieldName;
*
* visit(
* parse('{ greeting }'),
* visitWithTypeInfo(typeInfo, {
* Field: () => {
* fieldName = typeInfo.getFieldDef()?.name;
* },
* }),
* );
*
* fieldName; // => 'greeting'
* ```
*/
getFieldDef(): Maybe<GraphQLField<unknown, unknown>>;
/**
* Returns the default input representation for the current input position.
* @returns The current default input, if one is available.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* reviews(limit: Int = 10): [String]
* }
* `);
* const typeInfo = new TypeInfo(schema);
* let defaultLimit;
*
* visit(
* parse('{ reviews(limit: 5) }'),
* visitWithTypeInfo(typeInfo, {
* Argument: () => {
* defaultLimit = typeInfo.getDefaultValue();
* },
* }),
* );
*
* defaultLimit; // => { literal: { kind: 'IntValue', value: '10' } }
* ```
*/
getDefaultValue(): unknown;
/**
* Returns the current directive definition.
* @returns The current directive definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const typeInfo = new TypeInfo(schema);
* let directiveName;
*
* visit(
* parse('{ greeting @include(if: true) }'),
* visitWithTypeInfo(typeInfo, {
* Directive: () => {
* directiveName = typeInfo.getDirective()?.name;
* },
* }),
* );
*
* directiveName; // => 'include'
* ```
*/
getDirective(): Maybe<GraphQLDirective>;
/**
* Returns the current argument definition.
* @returns The current argument definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* reviews(limit: Int = 10): [String]
* }
* `);
* const typeInfo = new TypeInfo(schema);
* let argumentName;
*
* visit(
* parse('{ reviews(limit: 5) }'),
* visitWithTypeInfo(typeInfo, {
* Argument: () => {
* argumentName = typeInfo.getArgument()?.name;
* },
* }),
* );
*
* argumentName; // => 'limit'
* ```
*/
getArgument(): Maybe<GraphQLArgument>;
/**
* Returns the current fragment signature.
* @returns The fragment signature for the current fragment definition.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse(
* `
* {
* ...GreetingFields
* }
*
* fragment GreetingFields on Query {
* greeting
* }
* `,
* { experimentalFragmentArguments: true },
* );
* const typeInfo = new TypeInfo(schema);
* let fragmentName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* FragmentSpread: () => {
* fragmentName = typeInfo.getFragmentSignature()?.definition.name.value;
* },
* }),
* );
*
* fragmentName; // => 'GreetingFields'
* ```
*/
getFragmentSignature(): Maybe<FragmentSignature>;
/**
* Returns the function used to look up fragment signatures by name.
* @returns A function that maps fragment names to fragment signatures.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse(
* `
* {
* ...GreetingFields
* }
*
* fragment GreetingFields on Query {
* greeting
* }
* `,
* { experimentalFragmentArguments: true },
* );
* const typeInfo = new TypeInfo(schema);
* let fragmentName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Document: () => {
* const getFragmentSignature = typeInfo.getFragmentSignatureByName();
* fragmentName =
* getFragmentSignature('GreetingFields')?.definition.name.value;
* },
* }),
* );
*
* fragmentName; // => 'GreetingFields'
* ```
*/
getFragmentSignatureByName(): (fragmentName: string) => Maybe<FragmentSignature>;
/**
* Returns the current fragment argument definition.
* @returns The variable definition for the current fragment argument.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String): String
* }
* `);
* const document = parse(
* `
* {
* ...GreetingFields(name: "Ada")
* }
*
* fragment GreetingFields($name: String) on Query {
* greeting(name: $name)
* }
* `,
* { experimentalFragmentArguments: true },
* );
* const typeInfo = new TypeInfo(schema);
* let argumentName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* FragmentArgument: () => {
* argumentName = typeInfo.getFragmentArgument()?.variable.name.value;
* },
* }),
* );
*
* argumentName; // => 'name'
* ```
*/
getFragmentArgument(): Maybe<VariableDefinitionNode>;
/**
* Returns the current enum value definition.
* @returns The current enum value definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* enum Sort {
* NEWEST
* OLDEST
* }
*
* type Query {
* reviews(sort: Sort = NEWEST): [String]
* }
* `);
* const typeInfo = new TypeInfo(schema);
* let enumValueName;
*
* visit(
* parse('{ reviews(sort: OLDEST) }'),
* visitWithTypeInfo(typeInfo, {
* EnumValue: () => {
* enumValueName = typeInfo.getEnumValue()?.name;
* },
* }),
* );
*
* enumValueName; // => 'OLDEST'
* ```
*/
getEnumValue(): Maybe<GraphQLEnumValue>;
/**
* Updates this TypeInfo instance for an entered AST node.
* @param node - AST node being entered.
* @returns Nothing.
* @example
* ```ts
* import { Kind, parse } from 'graphql/language';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting }');
* const operation = document.definitions[0];
* const selectionSet = operation.selectionSet;
* const field = selectionSet.selections[0];
* const typeInfo = new TypeInfo(schema);
*
* typeInfo.enter(operation);
* typeInfo.enter(selectionSet);
* typeInfo.enter(field);
*
* field.kind; // => Kind.FIELD
* typeInfo.getParentType()?.name; // => 'Query'
* String(typeInfo.getType()); // => 'String'
* ```
*/
enter(node: ASTNode): void;
/**
* Updates this TypeInfo instance for a left AST node.
* @param node - AST node being entered.
* @returns Nothing.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting }');
* const operation = document.definitions[0];
* const selectionSet = operation.selectionSet;
* const field = selectionSet.selections[0];
* const typeInfo = new TypeInfo(schema);
*
* typeInfo.enter(operation);
* typeInfo.enter(selectionSet);
* typeInfo.enter(field);
* String(typeInfo.getType()); // => 'String'
*
* typeInfo.leave(field);
* typeInfo.getType(); // => undefined
* ```
*/
leave(node: ASTNode): void;
}
/**
* Creates a new visitor instance which maintains a provided TypeInfo instance
* along with visiting visitor.
* @param typeInfo - TypeInfo instance to update during traversal.
* @param visitor - Visitor callbacks to wrap with TypeInfo updates.
* @returns A visitor that keeps TypeInfo in sync while delegating callbacks.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const typeInfo = new TypeInfo(schema);
* const fields = [];
*
* visit(
* parse('{ greeting }'),
* visitWithTypeInfo(typeInfo, {
* Field: (node) => {
* fields.push({
* name: node.name.value,
* parentType: String(typeInfo.getParentType()),
* type: String(typeInfo.getType()),
* });
* },
* }),
* );
*
* fields; // => [{ name: 'greeting', parentType: 'Query', type: 'String' }]
* ```
*/
export declare function visitWithTypeInfo(typeInfo: TypeInfo, visitor: ASTVisitor): ASTVisitor;
type NodeWithSelectionSet = OperationDefinitionNode | FragmentDefinitionNode;
interface VariableUsage {
readonly node: VariableNode;
readonly type: Maybe<GraphQLInputType>;
readonly parentType: Maybe<GraphQLInputType>;
readonly defaultValue: unknown;
readonly fragmentVariableDefinition: Maybe<VariableDefinitionNode>;
}
declare class ASTValidationContext {
private _ast;
private _onError;
private _fragments;
private _fragmentSpreads;
private _recursivelyReferencedFragments;
constructor(ast: DocumentNode, onError: (error: GraphQLError) => void);
get [Symbol.toStringTag](): string;
reportError(error: GraphQLError): void;
getDocument(): DocumentNode;
getFragment(name: string): Maybe<FragmentDefinitionNode>;
getFragmentSpreads(node: SelectionSetNode): ReadonlyArray<FragmentSpreadNode>;
getRecursivelyReferencedFragments(operation: OperationDefinitionNode): ReadonlyArray<FragmentDefinitionNode>;
}
declare class SDLValidationContext extends ASTValidationContext {
private _schema;
constructor(ast: DocumentNode, schema: Maybe<GraphQLSchema>, onError: (error: GraphQLError) => void);
get hideSuggestions(): boolean;
get [Symbol.toStringTag](): string;
getSchema(): Maybe<GraphQLSchema>;
}
/** Validation context passed to query validation rules. */
export declare class ValidationContext extends ASTValidationContext {
private _schema;
private _typeInfo;
private _variableUsages;
private _recursiveVariableUsages;
private _hideSuggestions;
/**
* Creates a ValidationContext instance.
* @param schema - Schema used to validate the document.
* @param ast - Document AST being validated.
* @param typeInfo - TypeInfo instance used to track traversal state.
* @param onError - Callback invoked for each validation error.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { GraphQLError } from 'graphql/error';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting }');
* const errors = [];
* const context = new ValidationContext(
* schema,
* document,
* new TypeInfo(schema),
* (error) => errors.push(error),
* );
*
* context.reportError(new GraphQLError('Example validation error.'));
*
* context.getSchema(); // => schema
* errors[0].message; // => 'Example validation error.'
* ```
*/
constructor(schema: GraphQLSchema, ast: DocumentNode, typeInfo: TypeInfo, onError: (error: GraphQLError) => void, hideSuggestions?: Maybe<boolean>);
/**
* Returns the value used by `Object.prototype.toString`.
* @returns The built-in string tag for this object.
*/
get [Symbol.toStringTag](): string;
/**
* Returns whether validation error suggestions are hidden.
* @returns True when suggestion text should be omitted from errors.
*/
get hideSuggestions(): boolean;
/**
* Returns the schema being used by this validation context.
* @returns The schema being validated against.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const context = new ValidationContext(
* schema,
* parse('{ greeting }'),
* new TypeInfo(schema),
* () => {},
* );
*
* context.getSchema().getQueryType()?.name; // => 'Query'
* ```
*/
getSchema(): GraphQLSchema;
/**
* Returns variable usages found directly within this node.
* @param node - The AST node to inspect or visit.
* @returns Variable usages found directly within this node.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String): String
* }
* `);
* const document = parse('query ($name: String) { greeting(name: $name) }');
* const operation = document.definitions[0];
* const context = new ValidationContext(
* schema,
* document,
* new TypeInfo(schema),
* () => {},
* );
*
* const usages = context.getVariableUsages(operation);
*
* usages[0].node.name.value; // => 'name'
* String(usages[0].type); // => 'String'
* ```
*/
getVariableUsages(node: NodeWithSelectionSet): ReadonlyArray<VariableUsage>;
/**
* Returns variable usages for an operation, including variables used by referenced fragments.
* @param operation - Operation definition to inspect.
* @returns Variable usages reachable from the operation.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema, TypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* viewer: User
* }
*
* type User {
* name(prefix: String): String
* }
* `);
* const document = parse(`
* query ($prefix: String) {
* viewer {
* ...UserName
* }
* }
*
* fragment UserName on User {
* name(prefix: $prefix)
* }
* `);
* const operation = document.definitions[0];
* const context = new ValidationContext(
* schema,
* document,
* new TypeInfo(schema),
* () => {},
* );
*
* const usages = context.getRecursiveVariableUsages(operation);
*
* usages.map((usage) => usage.node.name.value); // => ['prefix']
* ```
*/
getRecursiveVariableUsages(operation: OperationDefinitionNode): ReadonlyArray<VariableUsage>;
/**
* Returns the current output type at this point in traversal.
* @returns The current output type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let typeName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Field: () => {
* typeName = String(context.getType());
* },
* }),
* );
*
* typeName; // => 'String'
* ```
*/
getType(): Maybe<GraphQLOutputType>;
/**
* Returns the current parent composite type.
* @returns The current parent composite type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let parentTypeName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Field: () => {
* parentTypeName = context.getParentType()?.name;
* },
* }),
* );
*
* parentTypeName; // => 'Query'
* ```
*/
getParentType(): Maybe<GraphQLCompositeType>;
/**
* Returns the current input type at this point in traversal.
* @returns The current input type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* reviews(limit: Int): [String]
* }
* `);
* const document = parse('{ reviews(limit: 5) }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let inputTypeName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Argument: () => {
* inputTypeName = String(context.getInputType());
* },
* }),
* );
*
* inputTypeName; // => 'Int'
* ```
*/
getInputType(): Maybe<GraphQLInputType>;
/**
* Returns the parent input type for the current input position.
* @returns The parent input type, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* input ReviewFilter {
* stars: Int
* }
*
* type Query {
* reviews(filter: ReviewFilter): [String]
* }
* `);
* const document = parse('{ reviews(filter: { stars: 5 }) }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let parentInputTypeName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* ObjectField: () => {
* parentInputTypeName = String(context.getParentInputType());
* },
* }),
* );
*
* parentInputTypeName; // => 'ReviewFilter'
* ```
*/
getParentInputType(): Maybe<GraphQLInputType>;
/**
* Returns the current field definition.
* @returns The current field definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let fieldName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Field: () => {
* fieldName = context.getFieldDef()?.name;
* },
* }),
* );
*
* fieldName; // => 'greeting'
* ```
*/
getFieldDef(): Maybe<GraphQLField<unknown, unknown>>;
/**
* Returns the current directive definition.
* @returns The current directive definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ greeting @include(if: true) }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let directiveName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Directive: () => {
* directiveName = context.getDirective()?.name;
* },
* }),
* );
*
* directiveName; // => 'include'
* ```
*/
getDirective(): Maybe<GraphQLDirective>;
/**
* Returns the current argument definition.
* @returns The current argument definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* reviews(limit: Int): [String]
* }
* `);
* const document = parse('{ reviews(limit: 5) }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let argumentName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Argument: () => {
* argumentName = context.getArgument()?.name;
* },
* }),
* );
*
* argumentName; // => 'limit'
* ```
*/
getArgument(): Maybe<GraphQLArgument>;
/**
* Returns the fragment signature at the current traversal position.
* @returns The current fragment signature, if one is active.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse(
* `
* {
* ...GreetingFields
* }
*
* fragment GreetingFields on Query {
* greeting
* }
* `,
* { experimentalFragmentArguments: true },
* );
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let fragmentName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* FragmentSpread: () => {
* fragmentName = context.getFragmentSignature()?.definition.name.value;
* },
* }),
* );
*
* fragmentName; // => 'GreetingFields'
* ```
*/
getFragmentSignature(): Maybe<FragmentSignature>;
/**
* Returns the function used to look up fragment signatures by name.
* @returns A function that maps fragment names to fragment signatures.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse(
* `
* {
* ...GreetingFields
* }
*
* fragment GreetingFields on Query {
* greeting
* }
* `,
* { experimentalFragmentArguments: true },
* );
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let fragmentName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* Document: () => {
* const getFragmentSignature = context.getFragmentSignatureByName();
* fragmentName =
* getFragmentSignature('GreetingFields')?.definition.name.value;
* },
* }),
* );
*
* fragmentName; // => 'GreetingFields'
* ```
*/
getFragmentSignatureByName(): (fragmentName: string) => Maybe<FragmentSignature>;
/**
* Returns the current enum value definition.
* @returns The current enum value definition, if known.
* @example
* ```ts
* import { parse, visit } from 'graphql/language';
* import { buildSchema, TypeInfo, visitWithTypeInfo } from 'graphql/utilities';
* import { ValidationContext } from 'graphql/validation';
*
* const schema = buildSchema(`
* enum Sort {
* NEWEST
* OLDEST
* }
*
* type Query {
* reviews(sort: Sort): [String]
* }
* `);
* const document = parse('{ reviews(sort: OLDEST) }');
* const typeInfo = new TypeInfo(schema);
* const context = new ValidationContext(schema, document, typeInfo, () => {});
* let enumValueName;
*
* visit(
* document,
* visitWithTypeInfo(typeInfo, {
* EnumValue: () => {
* enumValueName = context.getEnumValue()?.name;
* },
* }),
* );
*
* enumValueName; // => 'OLDEST'
* ```
*/
getEnumValue(): Maybe<GraphQLEnumValue>;
}
/** A function that creates an AST visitor for validating a GraphQL document. */
export type ValidationRule = (context: ValidationContext) => ASTVisitor;
/**
* Options used when validating a GraphQL document.
* @category Validation
*/
export interface ValidationOptions {
/** Maximum number of validation errors before validation stops. */
maxErrors?: number;
/** Whether suggestion text should be omitted from validation errors. */
hideSuggestions?: Maybe<boolean>;
}
/**
* Implements the "Validation" section of the spec.
*
* Validation runs synchronously, returning an array of encountered errors, or
* an empty array if no errors were encountered and the document is valid.
*
* A list of specific validation rules may be provided. If not provided, the
* default list of rules defined by the GraphQL specification will be used.
*
* Each validation rule is a function that returns a visitor
* (see the language/visitor API). Visitor methods are expected to return
* GraphQLErrors, or Arrays of GraphQLErrors when invalid.
*
* Validate will stop validation after a `maxErrors` limit has been reached.
* Attackers can send pathologically invalid queries to induce a DoS attack,
* so `maxErrors` defaults to 100 errors.
* @param schema - Schema to validate against.
* @param documentAST - Document AST to validate.
* @param rules - Validation rules to apply.
* @param options - Validation options, including error limits and suggestions.
* @returns Validation errors, or an empty array when the document is valid.
* @example
* ```ts
* // Validate with the default specified rules.
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { validate } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* fullName: String
* }
* `);
*
* validate(schema, parse('{ greeting }')); // => []
*
* const errors = validate(schema, parse('{ missing }'));
* errors[0].message; // => 'Cannot query field "missing" on type "Query".'
* ```
* @example
* ```ts
* // This variant uses a custom rule list and validation options.
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { FieldsOnCorrectTypeRule, validate } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const document = parse('{ missingOne missingTwo }');
*
* const errors = validate(schema, document, [FieldsOnCorrectTypeRule], {
* maxErrors: 1,
* });
*
* errors.length; // => 2
* errors[1].message; // => 'Too many validation errors, error limit reached. Validation aborted.'
*
* const hiddenSuggestionErrors = validate(
* schema,
* parse('{ name }'),
* [FieldsOnCorrectTypeRule],
* { hideSuggestions: true },
* );
*
* hiddenSuggestionErrors[0].message; // => 'Cannot query field "name" on type "Query".'
* ```
*/
export declare function validate(schema: GraphQLSchema, documentAST: DocumentNode, rules?: ReadonlyArray<ValidationRule>, options?: ValidationOptions): ReadonlyArray<GraphQLError>;
/** Function used to execute a validated root selection set for a subscription event. */
export type RootSelectionSetExecutor = (validatedExecutionArgs: ValidatedSubscriptionArgs) => PromiseOrValue<ExecutionResult>;
/**
* Implements the "Executing requests" section of the GraphQL specification.
*
* Returns either a synchronous ExecutionResult (if all encountered resolvers
* are synchronous), or a Promise of an ExecutionResult that will eventually be
* resolved and never rejected.
*
* If the schema is invalid, an error will be thrown immediately. GraphQL
* request errors, including missing operations and variable coercion errors,
* are returned in an errors-only ExecutionResult.
*
* Field errors are collected into the response instead of rejecting the
* returned promise. Only the field that produced the error and its descendants
* are omitted; sibling fields continue to execute. Errors from fields of
* non-null type may propagate to the nearest nullable parent, which can be the
* entire response data.
*
* This function does not support incremental delivery (`@defer` and `@stream`).
* Use `experimentalExecuteIncrementally` to execute operations with
* incremental delivery enabled.
* @param args - The arguments used to perform the operation.
* @returns A completed execution result, or a promise resolving to one when execution is asynchronous.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { execute } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String!): String
* }
* `);
*
* const result = await execute({
* schema,
* document: parse('query ($name: String!) { greeting(name: $name) }'),
* rootValue: {
* greeting: ({ name }) => `Hello, ${name}!`,
* },
* variableValues: { name: 'Ada' },
* });
*
* result; // => { data: { greeting: 'Hello, Ada!' } }
* ```
*/
export declare function execute(args: ExecutionArgs): PromiseOrValue<ExecutionResult>;
/**
* Implements the "Executing requests" section of the GraphQL specification,
* including `@defer` and `@stream` as proposed in
* https://github.com/graphql/graphql-spec/pull/742
*
* This function returns either a single ExecutionResult, or an
* ExperimentalIncrementalExecutionResults object containing an `initialResult`
* and a stream of `subsequentResults`.
*
* If the schema is invalid, an error will be thrown immediately. GraphQL
* request errors, including missing operations and variable coercion errors,
* are returned in an errors-only ExecutionResult.
* @param args - Execution arguments for the GraphQL operation.
* @returns A single execution result or incremental execution results.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { experimentalExecuteIncrementally } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* const result = await experimentalExecuteIncrementally({
* schema,
* document: parse('{ greeting }'),
* rootValue: { greeting: 'Hello' },
* });
*
* result; // => { data: { greeting: 'Hello' } }
* ```
* @category Incremental Execution
*/
export declare function experimentalExecuteIncrementally(args: ExecutionArgs): PromiseOrValue<ExecutionResult | ExperimentalIncrementalExecutionResults>;
/**
* Implements the "Executing operations" section of the spec.
*
* Returns either a synchronous ExecutionResult, or a Promise for an
* ExecutionResult, described by the "Response" section of the GraphQL
* specification.
*
* If errors are encountered while executing a GraphQL field, only that field
* and its descendants will be omitted, and sibling fields will still be
* executed. These field errors are collected into the returned result instead
* of being thrown or rejecting the returned promise.
*
* Errors from sub-fields of a NonNull type may propagate to the top level, at
* which point we still collect the error and null the parent field, which in
* this case is the entire response.
* @param validatedExecutionArgs - Validated execution arguments.
* @returns Execution result for the operation root selection set.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* executeRootSelectionSet,
* validateExecutionArgs,
* } from 'graphql/execution';
*
* const schema = buildSchema('type Query { greeting: String }');
* const validatedArgs = validateExecutionArgs({
* schema,
* document: parse('{ greeting }'),
* rootValue: { greeting: 'Hello' },
* });
*
* assert('schema' in validatedArgs);
*
* const result = await executeRootSelectionSet(validatedArgs);
* result; // => { data: { greeting: 'Hello' } }
* ```
*/
export declare function executeRootSelectionSet(validatedExecutionArgs: ValidatedExecutionArgs): PromiseOrValue<ExecutionResult>;
/**
* Executes the operation root selection set with incremental delivery enabled.
* @param validatedExecutionArgs - Validated execution arguments.
* @returns A single execution result or incremental execution results.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* experimentalExecuteRootSelectionSet,
* validateExecutionArgs,
* } from 'graphql/execution';
*
* const schema = buildSchema('type Query { greeting: String }');
* const validatedArgs = validateExecutionArgs({
* schema,
* document: parse('{ greeting }'),
* rootValue: { greeting: 'Hello' },
* });
*
* assert('schema' in validatedArgs);
*
* const result = await experimentalExecuteRootSelectionSet(validatedArgs);
* result; // => { data: { greeting: 'Hello' } }
* ```
* @category Incremental Execution
*/
export declare function experimentalExecuteRootSelectionSet(validatedExecutionArgs: ValidatedExecutionArgs): PromiseOrValue<ExecutionResult | ExperimentalIncrementalExecutionResults>;
/**
* Also implements the "Executing requests" section of the GraphQL specification.
* However, it guarantees to complete synchronously (or throw an error) assuming
* that all field resolvers are also synchronous.
* @param args - The arguments used to perform the operation.
* @returns Completed execution output for a synchronous operation.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { executeSync } from 'graphql/execution';
*
* const schema = buildSchema('type Query { greeting: String }');
*
* const result = executeSync({
* schema,
* document: parse('{ greeting }'),
* rootValue: { greeting: 'Hello' },
* });
*
* result; // => { data: { greeting: 'Hello' } }
* ```
*/
export declare function executeSync(args: ExecutionArgs): ExecutionResult;
/**
* Executes a subscription operation once for a single source event.
*
* Field errors are collected into the returned result instead of being thrown
* or rejecting the returned promise.
* @param validatedExecutionArgs - Validated subscription execution arguments.
* @returns Execution result for the subscription event.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* executeSubscriptionEvent,
* validateSubscriptionArgs,
* } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* noop: String
* }
*
* type Subscription {
* greeting: String
* }
* `);
* const validatedArgs = validateSubscriptionArgs({
* schema,
* document: parse('subscription { greeting }'),
* rootValue: { greeting: 'Hello' },
* });
*
* assert('schema' in validatedArgs);
*
* const result = await executeSubscriptionEvent(validatedArgs);
* result; // => { data: { greeting: 'Hello' } }
* ```
*/
export declare function executeSubscriptionEvent(validatedExecutionArgs: ValidatedSubscriptionArgs): PromiseOrValue<ExecutionResult>;
/**
* Implements the "Subscribe" algorithm described in the GraphQL specification.
*
* Returns either an AsyncGenerator (if successful), an ExecutionResult (error),
* or a Promise for one of those results. The call will throw immediately if
* the schema is invalid or the selected operation is not a subscription.
*
* GraphQL request errors, including missing operations and variable coercion
* errors, return or resolve to a GraphQL Response (ExecutionResult) with
* descriptive errors and no data.
*
* If the source stream could not be created due to faulty subscription resolver
* logic, a non-async-iterable resolver result, or a system error, the
* function will return or resolve to a single ExecutionResult containing
* `errors` and no `data`.
*
* If the operation succeeded, the function returns or resolves to an
* AsyncGenerator, which yields a stream of ExecutionResults representing the
* response stream.
*
* This function does not support incremental delivery (`@defer` and `@stream`).
* If an operation which would defer or stream data is executed with this
* function, a field error will be raised at the location of the `@defer` or
* `@stream` directive.
*
* Accepts an object with named arguments.
* @param args - Execution arguments for the subscription operation.
* @returns A response stream for a valid subscription, or an execution result containing errors.
* @example
* ```ts
* // Use a same-named rootValue function to provide the source event stream.
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { subscribe } from 'graphql/execution';
*
* async function* greetings() {
* yield { greeting: 'Hello' };
* yield { greeting: 'Bonjour' };
* }
*
* const schema = buildSchema(`
* type Query {
* noop: String
* }
*
* type Subscription {
* greeting: String
* }
* `);
*
* const result = await subscribe({
* schema,
* document: parse('subscription { greeting }'),
* rootValue: { greeting: () => greetings() },
* });
*
* assert('next' in result);
*
* const firstPayload = await result.next();
* firstPayload.value; // => { data: { greeting: 'Hello' } }
* ```
* @example
* ```ts
* // This variant supplies events through a custom subscribeFieldResolver.
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { subscribe } from 'graphql/execution';
*
* async function* defaultGreetings() {
* yield { greeting: 'Hello' };
* }
*
* async function* frenchGreetings() {
* yield { greeting: 'Bonjour' };
* }
*
* const schema = buildSchema(`
* type Query {
* noop: String
* }
*
* type Subscription {
* greeting(locale: String): String
* }
* `);
*
* const result = await subscribe({
* schema,
* document: parse(
* 'subscription Greeting($locale: String) { greeting(locale: $locale) }',
* ),
* rootValue: {
* greeting: (args, contextValue) => {
* const locale = args.locale ?? contextValue.defaultLocale;
* return locale === 'fr' ? frenchGreetings() : defaultGreetings();
* },
* },
* contextValue: { defaultLocale: 'fr' },
* variableValues: { locale: 'fr' },
* operationName: 'Greeting',
* subscribeFieldResolver: (rootValue, args, contextValue, info) => {
* args.locale; // => 'fr'
* return rootValue[info.fieldName](args, contextValue);
* },
* });
*
* assert('next' in result);
*
* const firstPayload = await result.next();
* firstPayload.value; // => { data: { greeting: 'Bonjour' } }
* ```
*/
export declare function subscribe(args: ExecutionArgs): PromiseOrValue<AsyncGenerator<ExecutionResult, void, void> | ExecutionResult>;
/**
* Implements the "CreateSourceEventStream" algorithm described in the
* GraphQL specification, resolving the subscription source event stream for a
* previously validated subscription request.
*
* Returns either an AsyncIterable (if successful), an ExecutionResult (error),
* or a Promise for one of those results. The call will throw immediately if
* it is not passed validated execution arguments.
*
* If the validated arguments do not result in a compliant subscription, a
* GraphQL Response (ExecutionResult) with descriptive errors and no data will
* be returned.
*
* If the source stream could not be created due to faulty subscription
* resolver logic or a system error, the function will return or
* resolve to a single ExecutionResult containing `errors` and no `data`.
*
* If the operation succeeded, the function returns or resolves to the
* AsyncIterable for the event stream returned by the resolver.
*
* A Source Event Stream represents a sequence of events, each of which triggers
* a GraphQL execution for that event.
*
* This may be useful when hosting the stateful subscription service in a
* different process or machine than the stateless GraphQL execution engine,
* or otherwise separating these two steps. For more on this, see the
* "Supporting Subscriptions at Scale" information in the GraphQL specification.
* @param validatedExecutionArgs - Validated subscription execution arguments.
* @returns A source event stream, or an execution result containing errors.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* createSourceEventStream,
* validateSubscriptionArgs,
* } from 'graphql/execution';
*
* async function* greetings() {
* yield { greeting: 'Hello' };
* }
*
* const schema = buildSchema(`
* type Query {
* noop: String
* }
*
* type Subscription {
* greeting: String
* }
* `);
* const validatedArgs = validateSubscriptionArgs({
* schema,
* document: parse('subscription { greeting }'),
* rootValue: { greeting: () => greetings() },
* });
*
* assert('schema' in validatedArgs);
*
* const stream = await createSourceEventStream(validatedArgs);
* Symbol.asyncIterator in stream; // => true
* ```
*/
export declare function createSourceEventStream(validatedExecutionArgs: ValidatedSubscriptionArgs): PromiseOrValue<AsyncIterable<unknown> | ExecutionResult>;
/**
* Validates the arguments passed to execute, subscribe, and their lower-level
* helpers.
*
* Throws if the schema is invalid. GraphQL request errors, including variable
* coercion errors, are returned as a GraphQLError array.
* @param args - Execution arguments to validate.
* @returns Validated execution arguments, or validation errors.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { validateExecutionArgs } from 'graphql/execution';
*
* const schema = buildSchema(`
* interface Named {
* name: String!
* }
*
* type User implements Named {
* name: String!
* }
*
* type Query {
* viewer: Named
* }
* `);
* const abortController = new AbortController();
* const validatedArgs = validateExecutionArgs({
* schema,
* document: parse('query Viewer { viewer { __typename name } }'),
* rootValue: { viewer: { kind: 'user', name: 'Ada' } },
* contextValue: { locale: 'en' },
* operationName: 'Viewer',
* fieldResolver: (source, _args, contextValue, info) => {
* contextValue.locale; // => 'en'
* return source[info.fieldName];
* },
* typeResolver: (value) => {
* return value.kind === 'user' ? 'User' : undefined;
* },
* hideSuggestions: true,
* abortSignal: abortController.signal,
* enableEarlyExecution: true,
* hooks: {
* asyncWorkFinished: () => {},
* },
* options: { maxCoercionErrors: 1 },
* });
*
* assert('operation' in validatedArgs);
*
* validatedArgs.operation.name?.value; // => 'Viewer'
* validatedArgs.hideSuggestions; // => true
* ```
*/
export declare function validateExecutionArgs(args: ExecutionArgs): ReadonlyArray<GraphQLError> | ValidatedExecutionArgs;
/**
* Validates execution arguments for a subscription operation.
*
* Throws if the schema is invalid or the selected operation is not a
* subscription. GraphQL request errors, including variable coercion errors, are
* returned as a GraphQLError array.
* @param args - Execution arguments to validate.
* @returns Validated subscription execution arguments, or validation errors.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { validateSubscriptionArgs } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* noop: String
* }
*
* type Subscription {
* greeting: String
* }
* `);
* const validatedArgs = validateSubscriptionArgs({
* schema,
* document: parse('subscription { greeting }'),
* });
*
* assert('operation' in validatedArgs);
*
* validatedArgs.operation.operation; // => 'subscription'
* ```
*/
export declare function validateSubscriptionArgs(args: ExecutionArgs): ReadonlyArray<GraphQLError> | ValidatedSubscriptionArgs;
/**
* If a resolveType function is not given, then a default resolve behavior is
* used which attempts two strategies:
*
* First, See if the provided value has a `__typename` field defined, if so, use
* that value as name of the resolved type.
*
* Otherwise, test each possible type for the abstract type by calling
* isTypeOf for the object being coerced, returning the first type that matches.
*/
export declare const defaultTypeResolver: GraphQLTypeResolver<unknown, unknown>;
/**
* If a resolve function is not given, then a default resolve behavior is used
* which takes the property of the source object of the same name as the field
* and returns it as the result, or if it's a function, returns the result
* of calling that function while passing along args and context value.
*/
export declare const defaultFieldResolver: GraphQLFieldResolver<unknown, unknown>;
/**
* Implements the "MapSourceToResponseEvent" algorithm described in the
* GraphQL specification, mapping each event from a subscription source event
* stream to an ExecutionResult in the response stream.
* @param validatedExecutionArgs - Validated subscription execution arguments.
* @param sourceEventStream - Source event stream returned by the subscription resolver.
* @param rootSelectionSetExecutor - Function used to execute each source event.
* @returns A response stream of execution results.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* mapSourceToResponseEvent,
* validateSubscriptionArgs,
* } from 'graphql/execution';
*
* async function* events() {
* yield { greeting: 'Hello' };
* }
*
* const schema = buildSchema(`
* type Query {
* noop: String
* }
*
* type Subscription {
* greeting: String
* }
* `);
* const validatedArgs = validateSubscriptionArgs({
* schema,
* document: parse('subscription { greeting }'),
* });
*
* assert('schema' in validatedArgs);
*
* const responseStream = mapSourceToResponseEvent(validatedArgs, events());
* const firstPayload = await responseStream.next();
*
* firstPayload.value; // => { data: { greeting: 'Hello' } }
* ```
*/
export declare function mapSourceToResponseEvent(validatedExecutionArgs: ValidatedSubscriptionArgs, sourceEventStream: AsyncIterable<unknown>, rootSelectionSetExecutor?: RootSelectionSetExecutor): AsyncGenerator<ExecutionResult, void, void>;
/** Function used by a GraphQL harness to parse GraphQL source text. */
export type GraphQLParseFn = (...args: Parameters<typeof parse>) => PromiseOrValue<ReturnType<typeof parse>>;
/** Function used by a GraphQL harness to validate a parsed document. */
export type GraphQLValidateFn = (...args: Parameters<typeof validate>) => PromiseOrValue<ReturnType<typeof validate>>;
/** Function used by a GraphQL harness to execute a valid operation. */
export type GraphQLExecuteFn = (...args: Parameters<typeof execute>) => ReturnType<typeof execute>;
/** Function used by a GraphQL harness to create a subscription response stream. */
export type GraphQLSubscribeFn = (...args: Parameters<typeof subscribe>) => ReturnType<typeof subscribe>;
/**
* Overrides for the parse, validate, execute, and subscribe stages used by the
* high-level `graphql` and `graphqlSync` request pipeline.
*/
export interface GraphQLHarness {
/** Parses GraphQL source text into a document AST. */
parse: GraphQLParseFn;
/** Validates a document AST against a schema. */
validate: GraphQLValidateFn;
/** Executes a valid operation. */
execute: GraphQLExecuteFn;
/** Creates a response stream for a subscription operation. */
subscribe: GraphQLSubscribeFn;
}
/**
* Default harness backed by GraphQL.js parse, validate, execute, and subscribe
* implementations.
*/
export declare const defaultHarness: GraphQLHarness;
/**
* Describes the input object accepted by `graphql` and `graphqlSync`.
*
* These arguments describe the full parse, validate, and execute lifecycle for
* a GraphQL request. They include parser options, validation options, execution
* options, and an optional harness for replacing pipeline stages.
*
* `graphql` and `graphqlSync` do not support incremental delivery (`@defer` and
* `@stream`); use `experimentalExecuteIncrementally` after parsing and
* validating when incremental delivery is required.
*/
export interface GraphQLArgs extends ParseOptions, ValidationOptions, Omit<ExecutionArgs, "document"> {
/**
* Custom parse, validate, execute, and subscribe functions for this request
* pipeline.
*/
harness?: GraphQLHarness | undefined;
/**
* A GraphQL language-formatted string or source object representing the
* requested operation.
*/
source: string | Source;
/** Validation rules to use instead of the specified rules. */
rules?: ReadonlyArray<ValidationRule> | undefined;
}
/**
* Parses, validates, and executes a GraphQL document against a schema.
*
* This is the primary entry point for fulfilling GraphQL operations. Use this
* when you want a single-call request lifecycle that returns a promise in all
* cases.
*
* More sophisticated GraphQL servers, such as those which persist queries, may
* wish to separate the validation and execution phases to a static-time tooling
* step and a server runtime step.
* @param args - Request execution arguments, including schema and source.
* @returns A promise that resolves to an execution result or validation errors.
* @example
* ```ts
* // Execute a complete asynchronous request with variables.
* import { graphql, buildSchema } from 'graphql';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String!): String
* }
* `);
*
* const result = await graphql({
* schema,
* source: 'query SayHello($name: String!) { greeting(name: $name) }',
* rootValue: {
* greeting: ({ name }) => `Hello, ${name}!`,
* },
* variableValues: { name: 'Ada' },
* operationName: 'SayHello',
* });
*
* result; // => { data: { greeting: 'Hello, Ada!' } }
* ```
* @example
* ```ts
* // This variant supplies context plus custom field and type resolvers.
* import { graphql, buildSchema } from 'graphql';
*
* const schema = buildSchema(`
* interface Named {
* name: String!
* }
*
* type User implements Named {
* name: String!
* }
*
* type Query {
* viewer: Named
* }
* `);
*
* const result = await graphql({
* schema,
* source: '{ viewer { __typename name } }',
* rootValue: { viewer: { kind: 'user', name: 'Ada' } },
* contextValue: { locale: 'en' },
* fieldResolver: (source, _args, context, info) => {
* context.locale; // => 'en'
* return source[info.fieldName];
* },
* typeResolver: (value) => {
* return value.kind === 'user' ? 'User' : undefined;
* },
* });
*
* result; // => { data: { viewer: { __typename: 'User', name: 'Ada' } } }
* ```
* @example
* ```ts
* // This variant customizes the request pipeline with a harness.
* import { buildSchema, defaultHarness, graphql } from 'graphql';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const stages = [];
* const abortController = new AbortController();
* const harness = {
* parse: (...args) => {
* stages.push('parse');
* return defaultHarness.parse(...args);
* },
* validate: (...args) => {
* stages.push('validate');
* return defaultHarness.validate(...args);
* },
* execute: (...args) => {
* stages.push('execute');
* return defaultHarness.execute(...args);
* },
* subscribe: (...args) => {
* stages.push('subscribe');
* return defaultHarness.subscribe(...args);
* },
* };
*
* const result = await graphql({
* schema,
* source: '{ greeting }',
* rootValue: { greeting: 'Hello' },
* rules: [],
* maxErrors: 25,
* hideSuggestions: true,
* noLocation: true,
* abortSignal: abortController.signal,
* harness,
* });
*
* result; // => { data: { greeting: 'Hello' } }
* stages; // => ['parse', 'validate', 'execute']
* ```
* @category Request Pipeline
*/
export declare function graphql(args: GraphQLArgs): Promise<ExecutionResult>;
/**
* Parses, validates, and executes a GraphQL document synchronously.
*
* This function guarantees that execution completes synchronously, or throws an
* error, assuming that all field resolvers are also synchronous. It throws when
* any resolver returns a promise.
* @param args - Request execution arguments, including schema and source.
* @returns Completed execution output, or request errors if parsing or
* validation fails.
* @example
* ```ts
* // Execute a complete synchronous request with variables.
* import { graphqlSync, buildSchema } from 'graphql';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String!): String
* }
* `);
*
* const result = graphqlSync({
* schema,
* source: 'query SayHello($name: String!) { greeting(name: $name) }',
* rootValue: {
* greeting: ({ name }) => `Hello, ${name}!`,
* },
* variableValues: { name: 'Ada' },
* operationName: 'SayHello',
* });
*
* result; // => { data: { greeting: 'Hello, Ada!' } }
* ```
* @example
* ```ts
* // This variant uses a synchronous custom field resolver and context.
* import { graphqlSync, buildSchema } from 'graphql';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* const result = graphqlSync({
* schema,
* source: '{ greeting }',
* fieldResolver: (_source, _args, contextValue) => {
* return contextValue.defaultGreeting;
* },
* contextValue: { defaultGreeting: 'Hello' },
* });
*
* result; // => { data: { greeting: 'Hello' } }
* ```
* @category Request Pipeline
*/
export declare function graphqlSync(args: GraphQLArgs): ExecutionResult;
/**
* Render a helpful description of the location in the GraphQL Source document.
* @param location - The AST location to print.
* @returns A formatted source excerpt with line and column information.
* @example
* ```ts
* import { parse, printLocation } from 'graphql/language';
*
* const document = parse('type Query { hello: String }');
* const location = document.definitions[0].loc;
*
* if (location) {
* const printed = printLocation(location);
*
* printed; // => 'GraphQL request:1:1\n1 | type Query { hello: String }\n | ^'
* }
* ```
*/
export declare function printLocation(location: Location$1): string;
/**
* Render a helpful description of the location in the GraphQL Source document.
* @param source - The source document that contains the location.
* @param sourceLocation - The 1-indexed line and column to print.
* @returns A formatted source excerpt with line and column information.
* @example
* ```ts
* import { Source, printSourceLocation } from 'graphql/language';
*
* const source = new Source('type Query { hello: String }');
* const printed = printSourceLocation(source, { line: 1, column: 14 });
*
* printed; // => 'GraphQL request:1:14\n1 | type Query { hello: String }\n | ^'
* ```
*/
export declare function printSourceLocation(source: Source, sourceLocation: SourceLocation): string;
/**
* Converts an AST into a string, using one set of reasonable
* formatting rules.
* @param ast - The GraphQL AST node to print.
* @returns A stable string representation of the AST.
* @example
* ```ts
* import { parse, print } from 'graphql';
*
* const ast = parse('{ hero { name } }');
* const text = print(ast);
*
* text; // => '{\n hero {\n name\n }\n}'
* ```
*/
export declare function print(ast: ASTNode): string;
/**
* Returns true when the AST node is a definition node.
* @param node - The AST node to test.
* @returns True when the AST node is a definition node.
* @example
* ```ts
* import { parse, isDefinitionNode } from 'graphql/language';
*
* const document = parse('{ hello }');
*
* isDefinitionNode(document.definitions[0]); // => true
* isDefinitionNode(document); // => false
* ```
*/
export declare function isDefinitionNode(node: ASTNode): node is DefinitionNode;
/**
* Returns true when the AST node is an executable definition node.
* @param node - The AST node to test.
* @returns True when the AST node is an executable definition node.
* @example
* ```ts
* import { parse, isExecutableDefinitionNode } from 'graphql/language';
*
* const query = parse('{ hello }');
* const schema = parse('type Query { hello: String }');
*
* isExecutableDefinitionNode(query.definitions[0]); // => true
* isExecutableDefinitionNode(schema.definitions[0]); // => false
* ```
*/
export declare function isExecutableDefinitionNode(node: ASTNode): node is ExecutableDefinitionNode;
/**
* A type predicate for SubscriptionOperationDefinitionNode.
* Useful anywhere that must distinguish subscription operations from
* queries and mutations, such as the subscription execution pipeline
* which routes events through a different code path.
* @param node - Operation definition node to test.
* @returns True when the operation definition is a subscription.
* @example
* ```ts
* import { parse, isSubscriptionOperationDefinitionNode } from 'graphql/language';
*
* const subscription = parse('subscription { greeting }').definitions[0];
* const query = parse('{ greeting }').definitions[0];
*
* isSubscriptionOperationDefinitionNode(subscription); // => true
* isSubscriptionOperationDefinitionNode(query); // => false
* ```
*/
export declare function isSubscriptionOperationDefinitionNode(node: OperationDefinitionNode): node is SubscriptionOperationDefinitionNode;
/**
* Returns true when the AST node is a selection node.
* @param node - The AST node to test.
* @returns True when the AST node is a selection node.
* @example
* ```ts
* import { Kind, isSelectionNode } from 'graphql/language';
*
* const field = { kind: Kind.FIELD, name: { kind: Kind.NAME, value: 'hello' } };
* const document = { kind: Kind.DOCUMENT, definitions: [] };
*
* isSelectionNode(field); // => true
* isSelectionNode(document); // => false
* ```
*/
export declare function isSelectionNode(node: ASTNode): node is SelectionNode;
/**
* Returns true when the AST node is a value node.
* @param node - The AST node to test.
* @returns True when the AST node is a value node.
* @example
* ```ts
* import { parseType, parseValue, isValueNode } from 'graphql/language';
*
* const value = parseValue('[42]');
* const type = parseType('[String!]');
*
* isValueNode(value); // => true
* isValueNode(type); // => false
* ```
*/
export declare function isValueNode(node: ASTNode): node is ValueNode;
/**
* Returns true when the AST node is a constant value node.
* @param node - The AST node to test.
* @returns True when the AST node is a constant value node.
* @example
* ```ts
* import {
* parseConstValue,
* parseValue,
* isConstValueNode,
* } from 'graphql/language';
*
* const value = parseConstValue('[42]');
* const variable = parseValue('$id');
*
* isConstValueNode(value); // => true
* isConstValueNode(variable); // => false
* ```
*/
export declare function isConstValueNode(node: ASTNode): node is ConstValueNode;
/**
* Returns true when the AST node is a type node.
* @param node - The AST node to test.
* @returns True when the AST node is a type node.
* @example
* ```ts
* import { parseType, parseValue, isTypeNode } from 'graphql/language';
*
* const type = parseType('[String!]');
* const value = parseValue('[42]');
*
* isTypeNode(type); // => true
* isTypeNode(value); // => false
* ```
*/
export declare function isTypeNode(node: ASTNode): node is TypeNode;
/**
* Returns true when the AST node is a type system definition node.
* @param node - The AST node to test.
* @returns True when the AST node is a type system definition node.
* @example
* ```ts
* import { parse, isTypeSystemDefinitionNode } from 'graphql/language';
*
* const schema = parse('type Query { hello: String }');
* const query = parse('{ hello }');
*
* isTypeSystemDefinitionNode(schema.definitions[0]); // => true
* isTypeSystemDefinitionNode(query.definitions[0]); // => false
* ```
*/
export declare function isTypeSystemDefinitionNode(node: ASTNode): node is TypeSystemDefinitionNode;
/**
* Returns true when the AST node is a type definition node.
* @param node - The AST node to test.
* @returns True when the AST node is a type definition node.
* @example
* ```ts
* import { parse, isTypeDefinitionNode } from 'graphql/language';
*
* const typeDefinition = parse('type Query { hello: String }');
* const directiveDefinition = parse('directive @cache on FIELD');
*
* isTypeDefinitionNode(typeDefinition.definitions[0]); // => true
* isTypeDefinitionNode(directiveDefinition.definitions[0]); // => false
* ```
*/
export declare function isTypeDefinitionNode(node: ASTNode): node is TypeDefinitionNode;
/**
* Returns true when the AST node is a type system extension node.
* @param node - The AST node to test.
* @returns True when the AST node is a type system extension node.
* @example
* ```ts
* import { parse, isTypeSystemExtensionNode } from 'graphql/language';
*
* const extension = parse('extend type Query { hello: String }');
* const definition = parse('type Query { hello: String }');
*
* isTypeSystemExtensionNode(extension.definitions[0]); // => true
* isTypeSystemExtensionNode(definition.definitions[0]); // => false
* ```
*/
export declare function isTypeSystemExtensionNode(node: ASTNode): node is TypeSystemExtensionNode;
/**
* Returns true when the AST node is a type extension node.
* @param node - The AST node to test.
* @returns True when the AST node is a type extension node.
* @example
* ```ts
* import { parse, isTypeExtensionNode } from 'graphql/language';
*
* const extension = parse('extend type Query { hello: String }');
* const schemaExtension = parse('extend schema { query: Query }');
*
* isTypeExtensionNode(extension.definitions[0]); // => true
* isTypeExtensionNode(schemaExtension.definitions[0]); // => false
* ```
*/
export declare function isTypeExtensionNode(node: ASTNode): node is TypeExtensionNode;
/**
* Returns true when the AST node is a schema coordinate node.
* @param node - The AST node to test.
* @returns True when the AST node is a schema coordinate node.
* @example
* ```ts
* import {
* parse,
* parseSchemaCoordinate,
* isSchemaCoordinateNode,
* } from 'graphql/language';
*
* const coordinate = parseSchemaCoordinate('Query.hero');
* const document = parse('{ hero }');
*
* isSchemaCoordinateNode(coordinate); // => true
* isSchemaCoordinateNode(document); // => false
* ```
*/
export declare function isSchemaCoordinateNode(node: ASTNode): node is SchemaCoordinateNode;
/**
* Results for an operation that produced legacy incremental payloads.
* @typeParam TInitialData - Shape of the initial result data payload.
* @typeParam TDeferredData - Shape of deferred fragment data payloads.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export interface LegacyExperimentalIncrementalExecutionResults<TInitialData = ObjMap<unknown>, TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Initial execution result delivered before subsequent legacy incremental payloads. */
initialResult: LegacyInitialIncrementalExecutionResult<TInitialData, TExtensions>;
/** Async stream of legacy incremental payloads delivered after the initial result. */
subsequentResults: AsyncGenerator<LegacySubsequentIncrementalExecutionResult<TDeferredData, TStreamItem, TExtensions>, void, void>;
}
/**
* Initial execution result for an operation that produced legacy incremental payloads.
*
* Unlike `InitialIncrementalExecutionResult`, the legacy initial result does
* not include a `pending` list. Subsequent payloads identify their location
* directly with `path` and optional `label` fields.
* @typeParam TInitialData - Shape of the initial data payload.
* @typeParam TExtensions - Shape of the extensions payload.
*/
export interface LegacyInitialIncrementalExecutionResult<TInitialData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> extends ExecutionResult<TInitialData, TExtensions> {
/** Data produced by the initial execution payload. */
data: TInitialData;
/** Indicates that subsequent legacy incremental payloads will follow. */
hasNext: true;
/** Additional non-standard metadata included in the initial result. */
extensions?: TExtensions;
}
/**
* Subsequent payload produced by legacy incremental execution.
*
* Legacy subsequent payloads may contain deferred fragment data, streamed list
* items, or only `hasNext: false` to complete the response stream.
* @typeParam TDeferredData - Shape of deferred fragment data payloads.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of the extensions payload.
*/
export interface LegacySubsequentIncrementalExecutionResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Deferred or streamed payloads delivered by this response. */
incremental?: ReadonlyArray<LegacyIncrementalResult<TDeferredData, TStreamItem, TExtensions>>;
/** Indicates whether more legacy incremental payloads will follow. */
hasNext: boolean;
/** Additional non-standard metadata included in this payload. */
extensions?: TExtensions;
}
/**
* Deferred fragment or streamed list payload produced by legacy incremental execution.
* @typeParam TDeferredData - Shape of deferred fragment data.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export type LegacyIncrementalResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> = LegacyIncrementalDeferResult<TDeferredData, TExtensions> | LegacyIncrementalStreamResult<TStreamItem, TExtensions>;
/**
* Legacy incremental payload produced by a deferred fragment.
*
* The payload location is identified directly by `path` and optional `label`
* instead of by an `id` from a pending entry.
* @typeParam TDeferredData - Shape of deferred fragment data.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export interface LegacyIncrementalDeferResult<TDeferredData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> extends ExecutionResult<TDeferredData, TExtensions> {
/** Response path to the deferred fragment payload. */
path: ReadonlyArray<string | number>;
/** Label from the `@defer` directive. */
label?: string;
}
/**
* Legacy incremental payload produced by a streamed list field.
* @typeParam TStreamItem - Shape of streamed list items.
* @typeParam TExtensions - Shape of extensions payloads.
*/
export interface LegacyIncrementalStreamResult<TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Errors raised while producing streamed items. */
errors?: ReadonlyArray<GraphQLError>;
/** Streamed list items delivered by this payload. */
items: ReadonlyArray<TStreamItem> | null;
/** Response path to the first streamed list item in this payload. */
path: ReadonlyArray<string | number>;
/** Label from the `@stream` directive. */
label?: string;
/** Additional non-standard metadata included in this payload. */
extensions?: TExtensions;
}
/**
* JSON-serializable form of legacy incremental execution results.
* @typeParam TInitialData - Shape of the formatted initial result data payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data payloads.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedLegacyExperimentalIncrementalExecutionResults<TInitialData = ObjMap<unknown>, TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Formatted initial execution result. */
initialResult: FormattedLegacyInitialIncrementalExecutionResult<TInitialData, TExtensions>;
/** Async stream of formatted legacy incremental payloads. */
subsequentResults: AsyncGenerator<FormattedLegacySubsequentIncrementalExecutionResult<TDeferredData, TStreamItem, TExtensions>, void, void>;
}
/**
* JSON-serializable form of a legacy initial incremental execution result.
* @typeParam TInitialData - Shape of the formatted initial data payload.
* @typeParam TExtensions - Shape of the formatted extensions payload.
*/
export interface FormattedLegacyInitialIncrementalExecutionResult<TInitialData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> extends FormattedExecutionResult<TInitialData, TExtensions> {
/** Formatted data produced by the initial execution payload. */
data: TInitialData;
/** Indicates that subsequent legacy incremental payloads will follow. */
hasNext: true;
/** Additional non-standard metadata included in the formatted initial result. */
extensions?: TExtensions;
}
/**
* JSON-serializable form of a legacy subsequent incremental execution payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data payloads.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedLegacySubsequentIncrementalExecutionResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Formatted deferred or streamed payloads delivered by this response. */
incremental?: ReadonlyArray<FormattedLegacyIncrementalResult<TDeferredData, TStreamItem, TExtensions>>;
/** Indicates whether more legacy incremental payloads will follow. */
hasNext: boolean;
/** Additional non-standard metadata included in this formatted payload. */
extensions?: TExtensions;
}
/**
* JSON-serializable deferred fragment or streamed list payload produced by
* legacy incremental execution.
* @typeParam TDeferredData - Shape of formatted deferred fragment data.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export type FormattedLegacyIncrementalResult<TDeferredData = ObjMap<unknown>, TStreamItem = unknown, TExtensions = ObjMap<unknown>> = FormattedLegacyIncrementalDeferResult<TDeferredData, TExtensions> | FormattedLegacyIncrementalStreamResult<TStreamItem, TExtensions>;
/**
* JSON-serializable form of a legacy deferred fragment payload.
* @typeParam TDeferredData - Shape of formatted deferred fragment data.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedLegacyIncrementalDeferResult<TDeferredData = ObjMap<unknown>, TExtensions = ObjMap<unknown>> extends FormattedExecutionResult<TDeferredData, TExtensions> {
/** Response path to the formatted deferred fragment payload. */
path: ReadonlyArray<string | number>;
/** Label from the `@defer` directive. */
label?: string;
}
/**
* JSON-serializable form of a legacy streamed list payload.
* @typeParam TStreamItem - Shape of formatted streamed list items.
* @typeParam TExtensions - Shape of formatted extensions payloads.
*/
export interface FormattedLegacyIncrementalStreamResult<TStreamItem = unknown, TExtensions = ObjMap<unknown>> {
/** Formatted errors raised while producing streamed items. */
errors?: ReadonlyArray<GraphQLFormattedError>;
/** Formatted streamed list items delivered by this payload. */
items: ReadonlyArray<TStreamItem> | null;
/** Response path to the first streamed list item in this formatted payload. */
path: ReadonlyArray<string | number>;
/** Label from the `@stream` directive. */
label?: string;
/** Additional non-standard metadata included in this formatted payload. */
extensions?: TExtensions;
}
/**
* Executes a GraphQL operation with support for `@defer` and `@stream` using
* the legacy incremental delivery payload format.
*
* Prefer `experimentalExecuteIncrementally` for the current incremental
* delivery format. In the legacy format, each subsequent incremental payload
* identifies its location with `path` and optional `label` fields. The current
* format instead tracks pending work by `id` and reports completion through
* `completed` entries.
* @param args - Execution arguments for the GraphQL operation.
* @returns A single execution result or legacy incremental execution results.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { legacyExecuteIncrementally } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* hero: Hero
* }
*
* type Hero {
* id: ID!
* name: String!
* }
* `);
*
* const result = await legacyExecuteIncrementally({
* schema,
* document: parse('{ hero { id ... @defer(label: "HeroName") { name } } }'),
* rootValue: { hero: { id: '1', name: 'Luke' } },
* });
*
* assert('initialResult' in result);
*
* result.initialResult; // => { data: { hero: { id: '1' } }, hasNext: true }
*
* const deferred = await result.subsequentResults.next();
* deferred.value; // => { incremental: [ { data: { name: 'Luke' }, path: ['hero'], label: 'HeroName' } ], hasNext: false }
* ```
* @example
* Compare the legacy payload format with the current incremental delivery
* format returned by `experimentalExecuteIncrementally`.
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* experimentalExecuteIncrementally,
* legacyExecuteIncrementally,
* } from 'graphql/execution';
*
* const schema = buildSchema(`
* type Query {
* hero: Hero
* }
*
* type Hero {
* id: ID!
* name: String!
* }
* `);
* const document = parse('{ hero { id ... @defer { name } } }');
* const rootValue = { hero: { id: '1', name: 'Luke' } };
*
* const experimental = await experimentalExecuteIncrementally({
* schema,
* document,
* rootValue,
* });
* const legacy = await legacyExecuteIncrementally({
* schema,
* document,
* rootValue,
* });
*
* assert('initialResult' in experimental);
* assert('initialResult' in legacy);
*
* experimental.initialResult; // => { data: { hero: { id: '1' } }, pending: [ { id: '0', path: ['hero'] } ], hasNext: true }
* legacy.initialResult; // => { data: { hero: { id: '1' } }, hasNext: true }
*
* const experimentalDeferred = await experimental.subsequentResults.next();
* experimentalDeferred.value; // => { incremental: [{ data: { name: 'Luke' }, id: '0' }], completed: [{ id: '0' }], hasNext: false }
*
* const legacyDeferred = await legacy.subsequentResults.next();
* legacyDeferred.value; // => { incremental: [ { data: { name: 'Luke' }, path: ['hero'] } ], hasNext: false }
* ```
* @example
* Compare streamed list payloads in the legacy and current incremental
* delivery formats.
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* experimentalExecuteIncrementally,
* legacyExecuteIncrementally,
* } from 'graphql/execution';
*
* const schema = buildSchema('type Query { colors: [String] }');
* const document = parse('{ colors @stream(initialCount: 1) }');
* const rootValue = { colors: ['red', 'green', 'blue'] };
*
* const experimental = await experimentalExecuteIncrementally({
* schema,
* document,
* rootValue,
* });
* const legacy = await legacyExecuteIncrementally({
* schema,
* document,
* rootValue,
* });
*
* assert('initialResult' in experimental);
* assert('initialResult' in legacy);
*
* experimental.initialResult; // => { data: { colors: ['red'] }, pending: [ { id: '0', path: ['colors'] } ], hasNext: true }
* legacy.initialResult; // => { data: { colors: ['red'] }, hasNext: true }
*
* const experimentalStream = await experimental.subsequentResults.next();
* experimentalStream.value; // => { incremental: [ { items: ['green', 'blue'], id: '0' } ], completed: [{ id: '0' }], hasNext: false }
*
* const legacyStream = await legacy.subsequentResults.next();
* legacyStream.value; // => { incremental: [ { items: ['green', 'blue'], path: ['colors', 1] } ], hasNext: false }
* ```
*/
export declare function legacyExecuteIncrementally(args: ExecutionArgs): PromiseOrValue<ExecutionResult | LegacyExperimentalIncrementalExecutionResults>;
/**
* Executes a validated operation root selection set with support for `@defer`
* and `@stream` using the legacy incremental delivery payload format.
* @param validatedExecutionArgs - Validated execution arguments.
* @returns A single execution result or legacy incremental execution results.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* legacyExecuteRootSelectionSet,
* validateExecutionArgs,
* } from 'graphql/execution';
*
* const schema = buildSchema('type Query { greeting: String }');
* const validatedArgs = validateExecutionArgs({
* schema,
* document: parse('{ greeting }'),
* rootValue: { greeting: 'Hello' },
* });
*
* assert('schema' in validatedArgs);
*
* const result = await legacyExecuteRootSelectionSet(validatedArgs);
* result; // => { data: { greeting: 'Hello' } }
* ```
*/
export declare function legacyExecuteRootSelectionSet(validatedExecutionArgs: ValidatedExecutionArgs): PromiseOrValue<ExecutionResult | LegacyExperimentalIncrementalExecutionResults>;
/**
* Technically these aren't part of the spec but they are strongly encouraged
* validation rules.
*/
export declare const recommendedRules: ReadonlyArray<ValidationRule>;
/**
* This set includes all validation rules defined by the GraphQL spec.
*
* The order of the rules in this list has been adjusted to lead to the
* most clear output when encountering multiple validation errors.
*/
export declare const specifiedRules: ReadonlyArray<ValidationRule>;
/**
* Defer and stream directive labels are unique
*
* A GraphQL document is only valid if defer and stream directives' label argument is static and unique.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { validate, DeferStreamDirectiveLabelRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* friends: [String]
* }
* `);
* const invalidDocument = parse(`
* {
* friends @stream(label: "friends")
* other: friends @stream(label: "friends")
* }
* `);
* const validDocument = parse(`
* {
* friends @stream(label: "friends")
* other: friends @stream(label: "otherFriends")
* }
* `);
*
* validate(schema, invalidDocument, [DeferStreamDirectiveLabelRule]).length; // => 1
* validate(schema, validDocument, [DeferStreamDirectiveLabelRule]); // => []
* ```
*/
export declare function DeferStreamDirectiveLabelRule(context: ValidationContext): ASTVisitor;
/**
* Defer and stream directives are used on valid root field
*
* A GraphQL document is only valid if defer directives are not used on root mutation or subscription types.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* validate,
* DeferStreamDirectiveOnRootFieldRule,
* } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* message: String
* }
*
* type Mutation {
* updateMessage: String
* }
* `);
* const invalidDocument = parse(`
* mutation { ... @defer { updateMessage } }
* `);
* const validDocument = parse(`
* { ... @defer { message } }
* `);
*
* validate(schema, invalidDocument, [DeferStreamDirectiveOnRootFieldRule]).length; // => 1
* validate(schema, validDocument, [DeferStreamDirectiveOnRootFieldRule]); // => []
* ```
*/
export declare function DeferStreamDirectiveOnRootFieldRule(context: ValidationContext): ASTVisitor;
/**
* Defer And Stream Directives Are Used On Valid Operations
*
* A GraphQL document is only valid if defer and stream directives are not used on root mutation or subscription types.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import {
* validate,
* DeferStreamDirectiveOnValidOperationsRule,
* } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* message: Message
* }
*
* type Subscription {
* message: Message
* }
*
* type Message {
* body: String
* }
* `);
* const invalidDocument = parse(`
* subscription {
* message {
* ...MessageBody @defer
* }
* }
*
* fragment MessageBody on Message {
* body
* }
* `);
* const validDocument = parse(`
* subscription {
* message {
* ...MessageBody @defer(if: false)
* }
* }
*
* fragment MessageBody on Message {
* body
* }
* `);
*
* validate(schema, invalidDocument, [DeferStreamDirectiveOnValidOperationsRule])
* .length; // => 1
* validate(schema, validDocument, [DeferStreamDirectiveOnValidOperationsRule]); // => []
* ```
*/
export declare function DeferStreamDirectiveOnValidOperationsRule(context: ValidationContext): ASTVisitor;
/**
* Executable definitions
*
* A GraphQL document is only valid for execution if all definitions are either
* operation or fragment definitions.
*
* See https://spec.graphql.org/draft/#sec-Executable-Definitions
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { ExecutableDefinitionsRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* type Extra { field: String }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* ExecutableDefinitionsRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name }
* `);
* const validErrors = validate(schema, validDocument, [
* ExecutableDefinitionsRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function ExecutableDefinitionsRule(context: ASTValidationContext): ASTVisitor;
/**
* Fields on correct type
*
* A GraphQL document is only valid if all fields selected are defined by the
* parent type, or are an allowed meta field such as __typename.
*
* See https://spec.graphql.org/draft/#sec-Field-Selections
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { FieldsOnCorrectTypeRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { missing }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* FieldsOnCorrectTypeRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name }
* `);
* const validErrors = validate(schema, validDocument, [FieldsOnCorrectTypeRule]);
*
* validErrors; // => []
* ```
*/
export declare function FieldsOnCorrectTypeRule(context: ValidationContext): ASTVisitor;
/**
* Fragments on composite type
*
* Fragments use a type condition to determine if they apply, since fragments
* can only be spread into a composite type (object, interface, or union), the
* type condition must also be a composite type.
*
* See https://spec.graphql.org/draft/#sec-Fragments-On-Composite-Types
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { FragmentsOnCompositeTypesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* fragment Bad on String { length }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* FragmentsOnCompositeTypesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* fragment Good on Query { name }
* `);
* const validErrors = validate(schema, validDocument, [
* FragmentsOnCompositeTypesRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function FragmentsOnCompositeTypesRule(context: ValidationContext): ASTVisitor;
/**
* Known argument names
*
* A GraphQL field is only valid if all supplied arguments are defined by
* that field.
*
* See https://spec.graphql.org/draft/#sec-Argument-Names
* See https://spec.graphql.org/draft/#sec-Directives-Are-In-Valid-Locations
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { KnownArgumentNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: String): String
* }
* `);
*
* const invalidDocument = parse(`
* { field(unknown: "1") }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* KnownArgumentNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { field(arg: "1") }
* `);
* const validErrors = validate(schema, validDocument, [KnownArgumentNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function KnownArgumentNamesRule(context: ValidationContext): ASTVisitor;
/**
* Known directives
*
* A GraphQL document is only valid if all `@directives` are known by the
* schema and legally positioned.
*
* See https://spec.graphql.org/draft/#sec-Directives-Are-Defined
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { KnownDirectivesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { name @unknown }
* `);
* const invalidErrors = validate(schema, invalidDocument, [KnownDirectivesRule]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name @include(if: true) }
* `);
* const validErrors = validate(schema, validDocument, [KnownDirectivesRule]);
*
* validErrors; // => []
* ```
*/
export declare function KnownDirectivesRule(context: ValidationContext | SDLValidationContext): ASTVisitor;
/**
* Known fragment names
*
* A GraphQL document is only valid if all `...Fragment` fragment spreads refer
* to fragments defined in the same document.
*
* See https://spec.graphql.org/draft/#sec-Fragment-spread-target-defined
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { KnownFragmentNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { ...Missing }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* KnownFragmentNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* fragment NameFields on Query { name } query { ...NameFields }
* `);
* const validErrors = validate(schema, validDocument, [KnownFragmentNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function KnownFragmentNamesRule(context: ValidationContext): ASTVisitor;
/**
* Known Operation Types
*
* A GraphQL document is only valid if when it contains an operation,
* the root type for the operation exists within the schema.
*
* See https://spec.graphql.org/draft/#sec-Operation-Type-Existence
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { validate, KnownOperationTypesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const invalidDocument = parse('mutation { greeting }');
* const validDocument = parse('{ greeting }');
*
* validate(schema, invalidDocument, [KnownOperationTypesRule])[0].message; // => 'The mutation operation is not supported by the schema.'
* validate(schema, validDocument, [KnownOperationTypesRule]); // => []
* ```
*/
export declare function KnownOperationTypesRule(context: ValidationContext): ASTVisitor;
/**
* Known type names
*
* A GraphQL document is only valid if referenced types (specifically
* variable definitions and fragment conditions) are defined by the type schema.
*
* See https://spec.graphql.org/draft/#sec-Fragment-Spread-Type-Existence
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { KnownTypeNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* fragment Bad on Missing { name }
* `);
* const invalidErrors = validate(schema, invalidDocument, [KnownTypeNamesRule]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* fragment Good on Query { name }
* `);
* const validErrors = validate(schema, validDocument, [KnownTypeNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function KnownTypeNamesRule(context: ValidationContext | SDLValidationContext): ASTVisitor;
/**
* Lone anonymous operation
*
* A GraphQL document is only valid if when it contains an anonymous operation
* (the query short-hand) that it contains only that one operation definition.
*
* See https://spec.graphql.org/draft/#sec-Lone-Anonymous-Operation
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { LoneAnonymousOperationRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* query { name } query Other { name }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* LoneAnonymousOperationRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name }
* `);
* const validErrors = validate(schema, validDocument, [
* LoneAnonymousOperationRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function LoneAnonymousOperationRule(context: ASTValidationContext): ASTVisitor;
/**
* No fragment cycles
*
* The graph of fragment spreads must not form any cycles including spreading itself.
* Otherwise an operation could infinitely spread or infinitely execute on cycles in the underlying data.
*
* See https://spec.graphql.org/draft/#sec-Fragment-spreads-must-not-form-cycles
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { NoFragmentCyclesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* fragment A on Query { ...B } fragment B on Query { ...A } query { ...A }
* `);
* const invalidErrors = validate(schema, invalidDocument, [NoFragmentCyclesRule]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* fragment A on Query { name } query { ...A }
* `);
* const validErrors = validate(schema, validDocument, [NoFragmentCyclesRule]);
*
* validErrors; // => []
* ```
*/
export declare function NoFragmentCyclesRule(context: ASTValidationContext): ASTVisitor;
/**
* No undefined variables
*
* A GraphQL operation is only valid if all variables encountered, both directly
* and via fragment spreads, are defined by that operation.
*
* See https://spec.graphql.org/draft/#sec-All-Variable-Uses-Defined
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { NoUndefinedVariablesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: ID): String
* }
* `);
*
* const invalidDocument = parse(`
* query ($id: ID) { field(arg: $missing) }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* NoUndefinedVariablesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* query ($id: ID) { field(arg: $id) }
* `);
* const validErrors = validate(schema, validDocument, [NoUndefinedVariablesRule]);
*
* validErrors; // => []
* ```
*/
export declare function NoUndefinedVariablesRule(context: ValidationContext): ASTVisitor;
/**
* No unused fragments
*
* A GraphQL document is only valid if all fragment definitions are spread
* within operations, or spread within other fragments spread within operations.
*
* See https://spec.graphql.org/draft/#sec-Fragments-Must-Be-Used
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { NoUnusedFragmentsRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* fragment Unused on Query { name } query { name }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* NoUnusedFragmentsRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* fragment Used on Query { name } query { ...Used }
* `);
* const validErrors = validate(schema, validDocument, [NoUnusedFragmentsRule]);
*
* validErrors; // => []
* ```
*/
export declare function NoUnusedFragmentsRule(context: ASTValidationContext): ASTVisitor;
/**
* No unused variables
*
* A GraphQL operation is only valid if all variables defined by an operation
* are used, either directly or within a spread fragment.
*
* See https://spec.graphql.org/draft/#sec-All-Variables-Used
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { NoUnusedVariablesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: ID): String
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* query ($id: ID) { name }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* NoUnusedVariablesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* query ($id: ID) { field(arg: $id) }
* `);
* const validErrors = validate(schema, validDocument, [NoUnusedVariablesRule]);
*
* validErrors; // => []
* ```
*/
export declare function NoUnusedVariablesRule(context: ValidationContext): ASTVisitor;
/**
* Overlapping fields can be merged
*
* A selection set is only valid if all fields (including spreading any
* fragments) either correspond to distinct response names or can be merged
* without ambiguity.
*
* See https://spec.graphql.org/draft/#sec-Field-Selection-Merging
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { OverlappingFieldsCanBeMergedRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* dog: Dog
* }
*
* type Dog {
* name: String
* barkVolume: Int
* }
* `);
*
* const invalidDocument = parse(`
* { dog { value: barkVolume value: name } }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* OverlappingFieldsCanBeMergedRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { dog { barkVolume name } }
* `);
* const validErrors = validate(schema, validDocument, [
* OverlappingFieldsCanBeMergedRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function OverlappingFieldsCanBeMergedRule(context: ValidationContext): ASTVisitor;
/**
* Possible fragment spread
*
* A fragment spread is only valid if the type condition could ever possibly
* be true: if there is a non-empty intersection of the possible parent types,
* and possible types which pass the type condition.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { PossibleFragmentSpreadsRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* dog: Dog
* }
*
* type Dog {
* barkVolume: Int
* }
*
* type Cat {
* meowVolume: Int
* }
* `);
*
* const invalidDocument = parse(`
* { dog { ... on Cat { meowVolume } } }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* PossibleFragmentSpreadsRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { dog { ... on Dog { barkVolume } } }
* `);
* const validErrors = validate(schema, validDocument, [
* PossibleFragmentSpreadsRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function PossibleFragmentSpreadsRule(context: ValidationContext): ASTVisitor;
/**
* Provided required arguments
*
* A field or directive is only valid if all required (non-null without a
* default value) field arguments have been provided.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { ProvidedRequiredArgumentsRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(required: String!): String
* }
* `);
*
* const invalidDocument = parse(`
* { field }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* ProvidedRequiredArgumentsRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { field(required: "x") }
* `);
* const validErrors = validate(schema, validDocument, [
* ProvidedRequiredArgumentsRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function ProvidedRequiredArgumentsRule(context: ValidationContext): ASTVisitor;
/**
* Scalar leafs
*
* A GraphQL document is valid only if all leaf fields (fields without
* sub selections) are of scalar or enum types.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { ScalarLeafsRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { name { length } }
* `);
* const invalidErrors = validate(schema, invalidDocument, [ScalarLeafsRule]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name }
* `);
* const validErrors = validate(schema, validDocument, [ScalarLeafsRule]);
*
* validErrors; // => []
* ```
*/
export declare function ScalarLeafsRule(context: ValidationContext): ASTVisitor;
/**
* Subscriptions must only include a non-introspection field.
*
* A GraphQL subscription is valid only if it contains a single root field and
* that root field is not an introspection field.
*
* See https://spec.graphql.org/draft/#sec-Single-root-field
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { SingleFieldSubscriptionsRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
*
* type Subscription {
* a: String
* b: String
* }
* `);
*
* const invalidDocument = parse(`
* subscription { a b }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* SingleFieldSubscriptionsRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* subscription { a }
* `);
* const validErrors = validate(schema, validDocument, [
* SingleFieldSubscriptionsRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function SingleFieldSubscriptionsRule(context: ValidationContext): ASTVisitor;
/**
* Stream directives are used on list fields
*
* A GraphQL document is only valid if stream directives are used on list fields.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { buildSchema } from 'graphql/utilities';
* import { validate, StreamDirectiveOnListFieldRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* friends: [String]
* }
* `);
* const invalidDocument = parse('{ name @stream(initialCount: 0) }');
* const validDocument = parse('{ friends @stream(initialCount: 0) }');
*
* validate(schema, invalidDocument, [StreamDirectiveOnListFieldRule]).length; // => 1
* validate(schema, validDocument, [StreamDirectiveOnListFieldRule]); // => []
* ```
*/
export declare function StreamDirectiveOnListFieldRule(context: ValidationContext): ASTVisitor;
/**
* Unique argument names
*
* A GraphQL field or directive is only valid if all supplied arguments are
* uniquely named.
*
* See https://spec.graphql.org/draft/#sec-Argument-Names
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { UniqueArgumentNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: String): String
* }
* `);
*
* const invalidDocument = parse(`
* { field(arg: "1", arg: "2") }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* UniqueArgumentNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { field(arg: "1") }
* `);
* const validErrors = validate(schema, validDocument, [UniqueArgumentNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function UniqueArgumentNamesRule(context: ASTValidationContext): ASTVisitor;
/**
* Unique directive names per location
*
* A GraphQL document is only valid if all non-repeatable directives at
* a given location are uniquely named.
*
* See https://spec.graphql.org/draft/#sec-Directives-Are-Unique-Per-Location
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { UniqueDirectivesPerLocationRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { name @include(if: true) @include(if: false) }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* UniqueDirectivesPerLocationRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name @include(if: true) }
* `);
* const validErrors = validate(schema, validDocument, [
* UniqueDirectivesPerLocationRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function UniqueDirectivesPerLocationRule(context: ValidationContext | SDLValidationContext): ASTVisitor;
/**
* Unique fragment names
*
* A GraphQL document is only valid if all defined fragments have unique names.
*
* See https://spec.graphql.org/draft/#sec-Fragment-Name-Uniqueness
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { UniqueFragmentNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* fragment A on Query { name } fragment A on Query { name } query { ...A }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* UniqueFragmentNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* fragment A on Query { name } query { ...A }
* `);
* const validErrors = validate(schema, validDocument, [UniqueFragmentNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function UniqueFragmentNamesRule(context: ASTValidationContext): ASTVisitor;
/**
* Unique input field names
*
* A GraphQL input object value is only valid if all supplied fields are
* uniquely named.
*
* See https://spec.graphql.org/draft/#sec-Input-Object-Field-Uniqueness
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { UniqueInputFieldNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* input Filter {
* name: String
* }
*
* type Query {
* search(filter: Filter): String
* }
* `);
*
* const invalidDocument = parse(`
* { search(filter: { name: "a", name: "b" }) }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* UniqueInputFieldNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { search(filter: { name: "a" }) }
* `);
* const validErrors = validate(schema, validDocument, [
* UniqueInputFieldNamesRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function UniqueInputFieldNamesRule(context: ASTValidationContext): ASTVisitor;
/**
* Unique operation names
*
* A GraphQL document is only valid if all defined operations have unique names.
*
* See https://spec.graphql.org/draft/#sec-Operation-Name-Uniqueness
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { UniqueOperationNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* query Same { name } query Same { name }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* UniqueOperationNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* query One { name } query Two { name }
* `);
* const validErrors = validate(schema, validDocument, [UniqueOperationNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function UniqueOperationNamesRule(context: ASTValidationContext): ASTVisitor;
/**
* Unique variable names
*
* A GraphQL operation is only valid if all its variables are uniquely named.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { UniqueVariableNamesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: ID): String
* }
* `);
*
* const invalidDocument = parse(`
* query ($id: ID, $id: ID) { field(arg: $id) }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* UniqueVariableNamesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* query ($id: ID) { field(arg: $id) }
* `);
* const validErrors = validate(schema, validDocument, [UniqueVariableNamesRule]);
*
* validErrors; // => []
* ```
*/
export declare function UniqueVariableNamesRule(context: ASTValidationContext): ASTVisitor;
/**
* Value literals of correct type
*
* A GraphQL document is only valid if all value literals are of the type
* expected at their position.
*
* See https://spec.graphql.org/draft/#sec-Values-of-Correct-Type
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { ValuesOfCorrectTypeRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* count(limit: Int): Int
* }
* `);
*
* const invalidDocument = parse(`
* { count(limit: "many") }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* ValuesOfCorrectTypeRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { count(limit: 1) }
* `);
* const validErrors = validate(schema, validDocument, [ValuesOfCorrectTypeRule]);
*
* validErrors; // => []
* ```
*/
export declare function ValuesOfCorrectTypeRule(context: ValidationContext): ASTVisitor;
/**
* Variables are input types
*
* A GraphQL operation is only valid if all the variables it defines are of
* input types (scalar, enum, or input object).
*
* See https://spec.graphql.org/draft/#sec-Variables-Are-Input-Types
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { VariablesAreInputTypesRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: ID): String
* }
*
* type User {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* query ($user: User) { field(arg: "1") }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* VariablesAreInputTypesRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* query ($id: ID) { field(arg: $id) }
* `);
* const validErrors = validate(schema, validDocument, [
* VariablesAreInputTypesRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function VariablesAreInputTypesRule(context: ValidationContext): ASTVisitor;
/**
* Variables in allowed position
*
* Variable usages must be compatible with the arguments they are passed to.
*
* See https://spec.graphql.org/draft/#sec-All-Variable-Usages-are-Allowed
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { VariablesInAllowedPositionRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* field(arg: ID!): String
* }
* `);
*
* const invalidDocument = parse(`
* query ($id: String) { field(arg: $id) }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* VariablesInAllowedPositionRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* query ($id: ID!) { field(arg: $id) }
* `);
* const validErrors = validate(schema, validDocument, [
* VariablesInAllowedPositionRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function VariablesInAllowedPositionRule(context: ValidationContext): ASTVisitor;
/**
* Implements the max introspection depth validation rule.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { MaxIntrospectionDepthRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { __schema { types { fields { type { fields { type { fields { name } } } } } } } }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* MaxIntrospectionDepthRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { __schema { queryType { name } } }
* `);
* const validErrors = validate(schema, validDocument, [
* MaxIntrospectionDepthRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function MaxIntrospectionDepthRule(context: ASTValidationContext): ASTVisitor;
/**
* Lone Schema definition
*
* A GraphQL document is only valid if it contains only one schema definition.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { LoneSchemaDefinitionRule } from 'graphql/validation';
*
* const invalidSDL = `
* schema { query: Query } schema { query: Query } type Query { name: String }
* `;
*
* LoneSchemaDefinitionRule.name; // => 'LoneSchemaDefinitionRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* schema { query: Query } type Query { name: String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function LoneSchemaDefinitionRule(context: SDLValidationContext): ASTVisitor;
/**
* Unique operation types
*
* A GraphQL document is only valid if it has only one type per operation.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { UniqueOperationTypesRule } from 'graphql/validation';
*
* const invalidSDL = `
* schema { query: Query query: Other } type Query { name: String } type Other { name: String }
* `;
*
* UniqueOperationTypesRule.name; // => 'UniqueOperationTypesRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* schema { query: Query } type Query { name: String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function UniqueOperationTypesRule(context: SDLValidationContext): ASTVisitor;
/**
* Unique type names
*
* A GraphQL document is only valid if all defined types have unique names.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { UniqueTypeNamesRule } from 'graphql/validation';
*
* const invalidSDL = `
* type Query { name: String } type Query { other: String }
* `;
*
* UniqueTypeNamesRule.name; // => 'UniqueTypeNamesRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* type Query { name: String } type Other { name: String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function UniqueTypeNamesRule(context: SDLValidationContext): ASTVisitor;
/**
* Unique enum value names
*
* A GraphQL enum type is only valid if all its values are uniquely named.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { UniqueEnumValueNamesRule } from 'graphql/validation';
*
* const invalidSDL = `
* enum Status { ACTIVE ACTIVE } type Query { status: Status }
* `;
*
* UniqueEnumValueNamesRule.name; // => 'UniqueEnumValueNamesRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* enum Status { ACTIVE INACTIVE } type Query { status: Status }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function UniqueEnumValueNamesRule(context: SDLValidationContext): ASTVisitor;
/**
* Unique field definition names
*
* A GraphQL complex type is only valid if all its fields are uniquely named.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { UniqueFieldDefinitionNamesRule } from 'graphql/validation';
*
* const invalidSDL = `
* type Query { name: String name: String }
* `;
*
* UniqueFieldDefinitionNamesRule.name; // => 'UniqueFieldDefinitionNamesRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* type Query { name: String other: String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function UniqueFieldDefinitionNamesRule(context: SDLValidationContext): ASTVisitor;
/**
* Unique argument definition names
*
* A GraphQL Object or Interface type is only valid if all its fields have uniquely named arguments.
* A GraphQL Directive is only valid if all its arguments are uniquely named.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { UniqueArgumentDefinitionNamesRule } from 'graphql/validation';
*
* const invalidSDL = `
* type Query { field(arg: String, arg: Int): String }
* `;
*
* UniqueArgumentDefinitionNamesRule.name; // => 'UniqueArgumentDefinitionNamesRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* type Query { field(arg: String): String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function UniqueArgumentDefinitionNamesRule(context: SDLValidationContext): ASTVisitor;
/**
* Unique directive names
*
* A GraphQL document is only valid if all defined directives have unique names.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { UniqueDirectiveNamesRule } from 'graphql/validation';
*
* const invalidSDL = `
* directive @tag on FIELD directive @tag on QUERY type Query { name: String }
* `;
*
* UniqueDirectiveNamesRule.name; // => 'UniqueDirectiveNamesRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* directive @tag on FIELD type Query { name: String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function UniqueDirectiveNamesRule(context: SDLValidationContext): ASTVisitor;
/**
* Possible type extension
*
* A type extension is only valid if the type is defined and has the same kind.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema } from 'graphql';
* import { PossibleTypeExtensionsRule } from 'graphql/validation';
*
* const invalidSDL = `
* extend type Missing { name: String } type Query { name: String }
* `;
*
* PossibleTypeExtensionsRule.name; // => 'PossibleTypeExtensionsRule'
* buildSchema(invalidSDL); // throws an error
*
* const validSDL = `
* type Query { name: String } extend type Query { other: String }
* `;
*
* buildSchema(validSDL); // does not throw
* ```
*/
export declare function PossibleTypeExtensionsRule(context: SDLValidationContext): ASTVisitor;
/**
* No deprecated
*
* A GraphQL document is only valid if all selected fields and all used enum values have not been
* deprecated.
*
* Note: This rule is optional and is not part of the Validation section of the GraphQL
* Specification. The main purpose of this rule is detection of deprecated usages and not
* necessarily to forbid their use when querying a service.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import {
* GraphQLObjectType,
* GraphQLSchema,
* GraphQLString,
* parse,
* validate,
* } from 'graphql';
* import { NoDeprecatedCustomRule } from 'graphql/validation';
*
* const schema = new GraphQLSchema({
* query: new GraphQLObjectType({
* name: 'Query',
* fields: {
* name: { type: GraphQLString },
* oldName: {
* type: GraphQLString,
* deprecationReason: 'Use name instead.',
* },
* },
* }),
* });
*
* const invalidDocument = parse(`
* { oldName }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* NoDeprecatedCustomRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name }
* `);
* const validErrors = validate(schema, validDocument, [NoDeprecatedCustomRule]);
*
* validErrors; // => []
* ```
*/
export declare function NoDeprecatedCustomRule(context: ValidationContext): ASTVisitor;
/**
* Prohibit introspection queries
*
* A GraphQL document is only valid if all fields selected are not fields that
* return an introspection type.
*
* Note: This rule is optional and is not part of the Validation section of the
* GraphQL Specification. This rule effectively disables introspection, which
* does not reflect best practices and should only be done if absolutely necessary.
* @param context - The validation context used while checking the document.
* @returns A visitor that reports validation errors for this rule.
* @example
* ```ts
* import { buildSchema, parse, validate } from 'graphql';
* import { NoSchemaIntrospectionCustomRule } from 'graphql/validation';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* const invalidDocument = parse(`
* { __schema { queryType { name } } }
* `);
* const invalidErrors = validate(schema, invalidDocument, [
* NoSchemaIntrospectionCustomRule,
* ]);
*
* invalidErrors.length; // => 1
*
* const validDocument = parse(`
* { name }
* `);
* const validErrors = validate(schema, validDocument, [
* NoSchemaIntrospectionCustomRule,
* ]);
*
* validErrors; // => []
* ```
*/
export declare function NoSchemaIntrospectionCustomRule(context: ValidationContext): ASTVisitor;
/**
* Produces a GraphQLError representing a syntax error, containing useful
* descriptive information about the syntax error's position in the source.
* @param source - The GraphQL source containing the syntax error.
* @param position - Character offset where the syntax error was encountered.
* @param description - Human-readable description of the syntax error.
* @returns A GraphQLError located at the syntax error position.
* @example
* ```ts
* import { Source } from 'graphql/language';
* import { syntaxError } from 'graphql/error';
*
* const error = syntaxError(new Source('query {'), 7, 'Expected Name');
*
* error.message; // => 'Syntax Error: Expected Name'
* error.locations; // => [{ line: 1, column: 8 }]
* ```
*/
export declare function syntaxError(source: Source, position: number, description: string): GraphQLError;
/**
* Given an arbitrary value, presumably thrown while attempting to execute a
* GraphQL operation, produce a new GraphQLError aware of the location in the
* document responsible for the original Error.
* @param rawOriginalError - The original error value to wrap.
* @param nodes - The AST nodes associated with the error.
* @param path - The response path associated with the error.
* @returns The GraphQL error.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { locatedError } from 'graphql/error';
*
* const document = parse('{ viewer { name } }');
* const fieldNode = document.definitions[0].selectionSet.selections[0];
* const error = locatedError(new Error('Resolver failed'), fieldNode, ['viewer']);
*
* error.message; // => 'Resolver failed'
* error.locations; // => [{ line: 1, column: 3 }]
* error.path; // => ['viewer']
* ```
*/
export declare function locatedError(rawOriginalError: unknown, nodes: ASTNode | ReadonlyArray<ASTNode> | undefined | null, path?: Maybe<ReadonlyArray<string | number>>): GraphQLError;
/** Options controlling which fields are included in the introspection query. */
export interface IntrospectionOptions {
/**
* Whether to include descriptions in the introspection result.
* Default: true
*/
descriptions?: boolean;
/**
* Whether to include `specifiedByURL` in the introspection result.
* Default: false
*/
specifiedByUrl?: boolean;
/**
* Whether to include `isRepeatable` flag on directives.
* Default: false
*/
directiveIsRepeatable?: boolean;
/**
* Whether to include `description` field on schema.
* Default: false
*/
schemaDescription?: boolean;
/**
* Whether target GraphQL server support deprecation of input values.
* Default: false
*/
inputValueDeprecation?: boolean;
/**
* Whether target GraphQL server supports deprecation of directives.
* Default: false
*/
experimentalDirectiveDeprecation?: boolean;
/**
* Whether target GraphQL server supports `@oneOf` input objects.
* Default: false
*/
oneOf?: boolean;
/**
* How deep to recurse into nested types, larger values will result in more
* accurate results, but have a higher load on the server.
* Some servers might restrict the maximum query depth or complexity.
* If that's the case, try decreasing this value.
*
* Default: 9
*/
typeDepth?: number;
}
/**
* Produce the GraphQL query recommended for a full schema introspection.
* Accepts optional IntrospectionOptions.
* @param options - Optional configuration for this operation.
* @returns The resolved introspection query.
* @example
* ```ts
* // Generate the default introspection query.
* import { getIntrospectionQuery } from 'graphql/utilities';
*
* const query = getIntrospectionQuery();
*
* query; // matches /__schema/
* query; // matches /description/
* query; // does not match /specifiedByURL/
* ```
* @example
* ```ts
* // This variant customizes optional introspection fields and nesting depth.
* import { getIntrospectionQuery } from 'graphql/utilities';
*
* const query = getIntrospectionQuery({
* descriptions: false,
* specifiedByUrl: true,
* directiveIsRepeatable: true,
* schemaDescription: true,
* inputValueDeprecation: true,
* experimentalDirectiveDeprecation: true,
* oneOf: true,
* typeDepth: 3,
* });
*
* query; // does not match /description/
* query; // matches /specifiedByURL/
* query; // matches /isRepeatable/
* query; // matches /includeDeprecated: true/
* query; // matches /isOneOf/
* (query.match(/ofType/g)?.length ?? 0) > 0; // => true
* ```
*/
export declare function getIntrospectionQuery(options?: IntrospectionOptions): string;
/** The result shape returned by a full introspection query. */
export interface IntrospectionQuery {
/** The schema. */
readonly __schema: IntrospectionSchema;
}
/** The introspection representation of a GraphQL schema. */
export interface IntrospectionSchema {
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** The root object type used for query operations. */
readonly queryType: IntrospectionNamedTypeRef<IntrospectionObjectType>;
/** The root object type used for mutation operations, if supported. */
readonly mutationType: Maybe<IntrospectionNamedTypeRef<IntrospectionObjectType>>;
/** The root object type used for subscription operations, if supported. */
readonly subscriptionType: Maybe<IntrospectionNamedTypeRef<IntrospectionObjectType>>;
/** Object types that belong to this union type. */
readonly types: ReadonlyArray<IntrospectionType>;
/** Directives available in this schema or applied to this AST node. */
readonly directives: ReadonlyArray<IntrospectionDirective>;
}
/** Any introspection representation of a GraphQL type. */
export type IntrospectionType = IntrospectionScalarType | IntrospectionObjectType | IntrospectionInterfaceType | IntrospectionUnionType | IntrospectionEnumType | IntrospectionInputObjectType;
/** An introspection type that can appear in output position. */
export type IntrospectionOutputType = IntrospectionScalarType | IntrospectionObjectType | IntrospectionInterfaceType | IntrospectionUnionType | IntrospectionEnumType;
/** An introspection type that can appear in input position. */
export type IntrospectionInputType = IntrospectionScalarType | IntrospectionEnumType | IntrospectionInputObjectType;
/** The introspection representation of a scalar type. */
export interface IntrospectionScalarType {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.SCALAR;
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** URL identifying the behavior specified for this custom scalar. */
readonly specifiedByURL?: Maybe<string>;
}
/** The introspection representation of an object type. */
export interface IntrospectionObjectType {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.OBJECT;
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields: ReadonlyArray<IntrospectionField>;
/** Interfaces implemented by this object or interface type. */
readonly interfaces: ReadonlyArray<IntrospectionNamedTypeRef<IntrospectionInterfaceType>>;
}
/** The introspection representation of an interface type. */
export interface IntrospectionInterfaceType {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.INTERFACE;
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Fields declared by this object, interface, input object, or literal. */
readonly fields: ReadonlyArray<IntrospectionField>;
/** Interfaces implemented by this object or interface type. */
readonly interfaces: ReadonlyArray<IntrospectionNamedTypeRef<IntrospectionInterfaceType>>;
/** Object types that may be returned for this abstract type. */
readonly possibleTypes: ReadonlyArray<IntrospectionNamedTypeRef<IntrospectionObjectType>>;
}
/** The introspection representation of a union type. */
export interface IntrospectionUnionType {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.UNION;
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Object types that may be returned for this abstract type. */
readonly possibleTypes: ReadonlyArray<IntrospectionNamedTypeRef<IntrospectionObjectType>>;
}
/** The introspection representation of an enum type. */
export interface IntrospectionEnumType {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.ENUM;
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Values declared by this enum type. */
readonly enumValues: ReadonlyArray<IntrospectionEnumValue>;
}
/** The introspection representation of an input object type. */
export interface IntrospectionInputObjectType {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.INPUT_OBJECT;
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Input fields declared by this input object type. */
readonly inputFields: ReadonlyArray<IntrospectionInputValue>;
/** Whether this input object uses the experimental OneOf input object semantics. */
readonly isOneOf: boolean;
}
/**
* The introspection representation of a list type reference.
* @typeParam T - The introspection type reference wrapped by this list type reference.
*/
export interface IntrospectionListTypeRef<T extends IntrospectionTypeRef = IntrospectionTypeRef> {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.LIST;
/** The type wrapped by this list or non-null type. */
readonly ofType: T;
}
/**
* The introspection representation of a non-null type reference.
* @typeParam T - The introspection type reference wrapped by this non-null type reference.
*/
export interface IntrospectionNonNullTypeRef<T extends IntrospectionTypeRef = IntrospectionTypeRef> {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: typeof TypeKind.NON_NULL;
/** The type wrapped by this list or non-null type. */
readonly ofType: T;
}
/** Any introspection representation of a type reference. */
export type IntrospectionTypeRef = IntrospectionNamedTypeRef | IntrospectionListTypeRef | IntrospectionNonNullTypeRef<IntrospectionNamedTypeRef | IntrospectionListTypeRef>;
/** An introspection type reference that can appear in output position. */
export type IntrospectionOutputTypeRef = IntrospectionNamedTypeRef<IntrospectionOutputType> | IntrospectionListTypeRef<IntrospectionOutputTypeRef> | IntrospectionNonNullTypeRef<IntrospectionNamedTypeRef<IntrospectionOutputType> | IntrospectionListTypeRef<IntrospectionOutputTypeRef>>;
/** An introspection type reference that can appear in input position. */
export type IntrospectionInputTypeRef = IntrospectionNamedTypeRef<IntrospectionInputType> | IntrospectionListTypeRef<IntrospectionInputTypeRef> | IntrospectionNonNullTypeRef<IntrospectionNamedTypeRef<IntrospectionInputType> | IntrospectionListTypeRef<IntrospectionInputTypeRef>>;
/**
* The introspection representation of a named type reference.
* @typeParam T - The introspection type represented by this named type reference.
*/
export interface IntrospectionNamedTypeRef<T extends IntrospectionType = IntrospectionType> {
/** The introspection kind discriminator for this type reference or type. */
readonly kind: T["kind"];
/** The GraphQL name for this schema element. */
readonly name: string;
}
/** The introspection representation of a field. */
export interface IntrospectionField {
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Arguments accepted by this field or directive. */
readonly args: ReadonlyArray<IntrospectionInputValue>;
/** The GraphQL type reference or runtime type for this element. */
readonly type: IntrospectionOutputTypeRef;
/** Whether this field, argument, enum value, or input value is deprecated. */
readonly isDeprecated: boolean;
/** Reason this element is deprecated, if one was provided. */
readonly deprecationReason: Maybe<string>;
}
/** The introspection representation of an argument or input field. */
export interface IntrospectionInputValue {
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** The GraphQL type reference or runtime type for this element. */
readonly type: IntrospectionInputTypeRef;
/** Default value used when no explicit value is supplied. */
readonly defaultValue: Maybe<string>;
/** Whether this field, argument, enum value, or input value is deprecated. */
readonly isDeprecated?: boolean;
/** Reason this element is deprecated, if one was provided. */
readonly deprecationReason?: Maybe<string>;
}
/** The introspection representation of an enum value. */
export interface IntrospectionEnumValue {
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Whether this field, argument, enum value, or input value is deprecated. */
readonly isDeprecated: boolean;
/** Reason this element is deprecated, if one was provided. */
readonly deprecationReason: Maybe<string>;
}
/** The introspection representation of a directive. */
export interface IntrospectionDirective {
/** The GraphQL name for this schema element. */
readonly name: string;
/** Human-readable description for this schema element, if provided. */
readonly description?: Maybe<string>;
/** Whether this directive may appear more than once at the same location. */
readonly isRepeatable?: boolean;
/** Whether this field, argument, enum value, or input value is deprecated. */
readonly isDeprecated?: boolean;
/** Reason this element is deprecated, if one was provided. */
readonly deprecationReason?: Maybe<string>;
/** Locations where this directive may be applied. */
readonly locations: ReadonlyArray<DirectiveLocation>;
/** Arguments accepted by this field or directive. */
readonly args: ReadonlyArray<IntrospectionInputValue>;
}
/**
* Returns an operation AST given a document AST and optionally an operation
* name. If a name is not provided, an operation is only returned if only one is
* provided in the document.
* @param documentAST - The parsed GraphQL document AST.
* @param operationName - The optional operation name to select.
* @returns The resolved operation ast.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { getOperationAST } from 'graphql/utilities';
*
* const document = parse('query GetName { name }');
* const operation = getOperationAST(document, 'GetName');
*
* operation.name.value; // => 'GetName'
* getOperationAST(document, 'Missing'); // => undefined
* ```
*/
export declare function getOperationAST(documentAST: DocumentNode, operationName?: Maybe<string>): Maybe<OperationDefinitionNode>;
/**
* Build an IntrospectionQuery from a GraphQLSchema
*
* IntrospectionQuery is useful for utilities that care about type and field
* relationships, but do not need to traverse through those relationships.
*
* This is the inverse of buildClientSchema. The primary use case is outside
* of the server context, for instance when doing schema comparisons.
* @param schema - GraphQL schema to use.
* @param options - Optional configuration for this operation.
* @returns Introspection result data for the schema.
* @example
* ```ts
* // Include schema metadata using the default introspection options.
* import { buildSchema, introspectionFromSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* scalar Url @specifiedBy(url: "https://url.spec.whatwg.org/")
*
* type Query {
* homepage: Url
* }
* `);
*
* const introspection = introspectionFromSchema(schema);
* const urlType = introspection.__schema.types.find(
* (type) => type.name === 'Url',
* );
*
* urlType.specifiedByURL; // => 'https://url.spec.whatwg.org/'
* ```
* @example
* ```ts
* // This variant disables optional introspection metadata.
* import { buildSchema, introspectionFromSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* scalar Url @specifiedBy(url: "https://url.spec.whatwg.org/")
*
* type Query {
* homepage: Url
* }
* `);
*
* const introspection = introspectionFromSchema(schema, {
* descriptions: false,
* specifiedByUrl: false,
* directiveIsRepeatable: false,
* schemaDescription: false,
* inputValueDeprecation: false,
* experimentalDirectiveDeprecation: false,
* oneOf: false,
* });
* const urlType = introspection.__schema.types.find(
* (type) => type.name === 'Url',
* );
* const deprecatedDirective = introspection.__schema.directives.find(
* (directive) => directive.name === 'deprecated',
* );
*
* urlType.specifiedByURL; // => undefined
* urlType.description; // => undefined
* introspection.__schema.description; // => undefined
* deprecatedDirective.isRepeatable; // => undefined
* ```
*/
export declare function introspectionFromSchema(schema: GraphQLSchema, options?: IntrospectionOptions): IntrospectionQuery;
/**
* Build a GraphQLSchema for use by client tools.
*
* Given the result of a client running the introspection query, creates and
* returns a GraphQLSchema instance which can be then used with all graphql-js
* tools, but cannot be used to execute a query, as introspection does not
* represent the "resolver", "parse" or "serialize" functions or any other
* server-internal mechanisms.
*
* This function expects a complete introspection result. Don't forget to check
* the "errors" field of a server response before calling this function.
* @param introspection - Introspection result data to build from.
* @param options - Optional configuration for this operation.
* @returns The client schema represented by the introspection result.
* @example
* ```ts
* import {
* buildClientSchema,
* introspectionFromSchema,
* buildSchema,
* } from 'graphql/utilities';
*
* const schema = buildSchema('type Query { hello: String }');
* const clientSchema = buildClientSchema(introspectionFromSchema(schema), {
* assumeValid: true,
* });
*
* clientSchema.getQueryType().name; // => 'Query'
* ```
*/
export declare function buildClientSchema(introspection: IntrospectionQuery, options?: GraphQLSchemaValidationOptions): GraphQLSchema;
/** Options used when building a schema from SDL or a parsed SDL document. */
export interface BuildSchemaOptions extends GraphQLSchemaValidationOptions {
/**
* Set to true to assume the SDL is valid.
*
* Default: false
*/
assumeValidSDL?: boolean | undefined;
}
/**
* Builds a GraphQLSchema from a parsed schema definition language document.
*
* If no schema definition is provided, then it will look for types named Query,
* Mutation and Subscription.
*
* The resulting schema has no resolver functions, so execution will use the
* default field resolver.
* @param documentAST - The parsed GraphQL document AST.
* @param options - Optional configuration for this operation.
* @returns The schema built from the provided SDL document.
* @example
* ```ts
* // Build a schema from a valid parsed SDL document.
* import { parse } from 'graphql/language';
* import { buildASTSchema } from 'graphql/utilities';
*
* const document = parse('type Query { hello: String }');
* const schema = buildASTSchema(document);
*
* schema.getQueryType().name; // => 'Query'
* ```
* @example
* ```ts
* // This variant uses validation options when the SDL references unknown types.
* import { parse } from 'graphql/language';
* import { buildASTSchema } from 'graphql/utilities';
*
* const document = parse('type Query { broken: MissingType }');
*
* buildASTSchema(document); // throws an error
* buildASTSchema(document, {
* assumeValid: true,
* assumeValidSDL: true,
* }); // does not throw
* ```
*/
export declare function buildASTSchema(documentAST: DocumentNode, options?: BuildSchemaOptions): GraphQLSchema;
/**
* Builds a GraphQLSchema directly from a schema definition language source.
* @param source - The GraphQL source text or source object.
* @param options - Optional configuration for this operation.
* @returns The schema built from the provided SDL document.
* @example
* ```ts
* // Build a schema from SDL source using the default options.
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema('type Query { hello: String }');
*
* schema.getQueryType().name; // => 'Query'
* ```
* @example
* ```ts
* // This variant enables parser options and omits source locations.
* import { buildSchema } from 'graphql/utilities';
*
* const schema = buildSchema(
* 'directive @tag on FIELD_DEFINITION\n' +
* 'directive @compose @tag on FIELD_DEFINITION',
* {
* experimentalFragmentArguments: true,
* noLocation: true,
* },
* );
*
* const directive = schema.getDirective('compose');
*
* directive.name; // => 'compose'
* directive.astNode.loc; // => undefined
* ```
*/
export declare function buildSchema(source: string | Source, options?: BuildSchemaOptions & ParseOptions): GraphQLSchema;
interface Options extends GraphQLSchemaValidationOptions {
/**
* Set to true to assume the SDL is valid.
*
* Default: false
*
* @internal
*/
assumeValidSDL?: boolean | undefined;
}
/**
* Produces a new schema given an existing schema and a document which may
* contain GraphQL type extensions and definitions. The original schema will
* remain unaltered.
*
* Because a schema represents a graph of references, a schema cannot be
* extended without effectively making an entire copy. We do not know until it's
* too late if subgraphs remain unchanged.
*
* This algorithm copies the provided schema, applying extensions while
* producing the copy. The original schema remains unaltered.
* @param schema - GraphQL schema to use.
* @param documentAST - The parsed GraphQL document AST.
* @param options - Optional configuration for this operation.
* @returns A new schema with the extensions and definitions applied.
* @example
* ```ts
* // Extend a schema with new fields and types.
* import { parse } from 'graphql/language';
* import { buildSchema, extendSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const extensionAST = parse(`
* extend type Query {
* farewell: String
* }
*
* type Review {
* body: String
* }
* `);
*
* const extendedSchema = extendSchema(schema, extensionAST);
*
* schema.getType('Review'); // => undefined
* extendedSchema.getType('Review')?.name; // => 'Review'
* Object.keys(extendedSchema.getQueryType().getFields()); // => ['greeting', 'farewell']
* ```
* @example
* ```ts
* // This variant bypasses validation for an otherwise invalid extension.
* import { parse } from 'graphql/language';
* import { buildSchema, extendSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const invalidExtension = parse(`
* extend type Missing {
* field: String
* }
* `);
*
* extendSchema(schema, invalidExtension); // throws an error
* extendSchema(schema, invalidExtension, {
* assumeValid: true,
* assumeValidSDL: true,
* }); // does not throw
* ```
*/
export declare function extendSchema(schema: GraphQLSchema, documentAST: DocumentNode, options?: Options): GraphQLSchema;
/**
* Sort GraphQLSchema.
*
* This function returns a sorted copy of the given GraphQLSchema.
* @param schema - GraphQL schema to use.
* @returns A copy of the schema with types, fields, arguments, and values sorted lexicographically.
* @example
* ```ts
* import {
* buildSchema,
* lexicographicSortSchema,
* printSchema,
* } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* zebra: String
* apple: String
* }
*
* enum Episode {
* JEDI
* NEW_HOPE
* EMPIRE
* }
* `);
*
* const sortedSchema = lexicographicSortSchema(schema);
*
* printSchema(sortedSchema);
* // =>
* // enum Episode {
* // EMPIRE
* // JEDI
* // NEW_HOPE
* // }
* //
* // type Query {
* // apple: String
* // zebra: String
* // }
* ```
*/
export declare function lexicographicSortSchema(schema: GraphQLSchema): GraphQLSchema;
/**
* Prints the schema.
* @param schema - GraphQL schema to use.
* @returns The printed string representation.
* @example
* ```ts
* import { buildSchema, printSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* directive @upper on FIELD_DEFINITION
*
* type Query {
* greeting: String @upper
* }
* `);
*
* printSchema(schema); // => ['directive @upper on FIELD_DEFINITION', '', 'type Query {', ' greeting: String', '}'].join('\n')
* ```
*/
export declare function printSchema(schema: GraphQLSchema): string;
/**
* Prints the introspection schema.
* @param schema - GraphQL schema to use.
* @returns The printed string representation.
* @example
* ```ts
* import { buildSchema, printIntrospectionSchema } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
*
* const printed = printIntrospectionSchema(schema);
*
* printed; // matches /type __Schema/
* printed; // matches /enum __TypeKind/
* printed; // does not match /type Query/
* ```
*/
export declare function printIntrospectionSchema(schema: GraphQLSchema): string;
/**
* Prints the type.
* @param type - The GraphQL type to inspect.
* @returns The printed string representation.
* @example
* ```ts
* import { buildSchema, printType } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type User {
* id: ID!
* name: String
* }
*
* type Query {
* viewer: User
* }
* `);
*
* printType(schema.getType('User')); // => ['type User {', ' id: ID!', ' name: String', '}'].join('\n')
* ```
*/
export declare function printType(type: GraphQLNamedType): string;
/**
* Prints a directive definition in GraphQL SDL.
* @param directive - Directive to print.
* @returns SDL string for the directive definition.
* @example
* ```ts
* import {
* DirectiveLocation,
* GraphQLDirective,
* GraphQLString,
* } from 'graphql/type';
* import { printDirective } from 'graphql/utilities';
*
* const authDirective = new GraphQLDirective({
* name: 'auth',
* description: 'Requires authorization.',
* locations: [DirectiveLocation.FIELD_DEFINITION],
* args: {
* scope: { type: GraphQLString },
* },
* });
*
* printDirective(authDirective); // => '"""Requires authorization."""\ndirective @auth(scope: String) on FIELD_DEFINITION'
* ```
*/
export declare function printDirective(directive: GraphQLDirective): string;
/**
* Given a Schema and an AST node describing a type, return a GraphQLType
* definition which applies to that type. For example, if provided the parsed
* AST node for `[User]`, a GraphQLList instance will be returned, containing
* the type called "User" found in the schema. If a type called "User" is not
* found in the schema, then undefined will be returned.
* @param schema - GraphQL schema to use.
* @param typeNode - The GraphQL type AST node to resolve.
* @returns The GraphQL type referenced by the AST node, or undefined if it cannot be resolved.
* @example
* ```ts
* import { parseType } from 'graphql/language';
* import { buildSchema, typeFromAST } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* name: String
* }
* `);
*
* typeFromAST(schema, parseType('String'))?.toString(); // => 'String'
* typeFromAST(schema, parseType('Missing')); // => undefined
* ```
*/
export declare function typeFromAST(schema: GraphQLSchema, typeNode: NamedTypeNode): GraphQLNamedType | undefined;
/**
* Resolves a list type AST node against a schema.
* @param schema - GraphQL schema to use.
* @param typeNode - The list type AST node to resolve.
* @returns The GraphQL list type referenced by the AST node, or undefined if
* it cannot be resolved.
* @example
* ```ts
* import { parseType } from 'graphql/language';
* import { buildSchema, typeFromAST } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* tags: [String]
* }
* `);
*
* typeFromAST(schema, parseType('[String]'))?.toString(); // => '[String]'
* typeFromAST(schema, parseType('[Missing]')); // => undefined
* ```
*/
export declare function typeFromAST(schema: GraphQLSchema, typeNode: ListTypeNode): GraphQLList<any> | undefined;
/**
* Resolves a non-null type AST node against a schema.
* @param schema - GraphQL schema to use.
* @param typeNode - The non-null type AST node to resolve.
* @returns The GraphQL non-null type referenced by the AST node, or undefined
* if it cannot be resolved.
* @example
* ```ts
* import { parseType } from 'graphql/language';
* import { buildSchema, typeFromAST } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* name: String!
* }
* `);
*
* typeFromAST(schema, parseType('String!'))?.toString(); // => 'String!'
* typeFromAST(schema, parseType('[String!]!'))?.toString(); // => '[String!]!'
* ```
*/
export declare function typeFromAST(schema: GraphQLSchema, typeNode: NonNullTypeNode): GraphQLNonNull<any> | undefined;
/**
* Resolves a type AST node against a schema.
* @param schema - GraphQL schema to use.
* @param typeNode - The GraphQL type AST node to resolve.
* @returns The GraphQL type referenced by the AST node, or undefined if it
* cannot be resolved.
* @example
* ```ts
* import { parseType } from 'graphql/language';
* import { buildSchema, typeFromAST } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type User {
* name: String
* }
*
* type Query {
* users: [User!]!
* }
* `);
*
* typeFromAST(schema, parseType('User'))?.toString(); // => 'User'
* typeFromAST(schema, parseType('[User!]!'))?.toString(); // => '[User!]!'
* typeFromAST(schema, parseType('Missing')); // => undefined
* ```
*/
export declare function typeFromAST(schema: GraphQLSchema, typeNode: TypeNode): GraphQLType | undefined;
/**
* Produces a JavaScript value given a GraphQL Value AST.
*
* A GraphQL type must be provided, which will be used to interpret different
* GraphQL Value literals.
*
* Returns `undefined` when the value could not be validly coerced according to
* the provided type.
*
* This deprecated function will be removed in v18. Use `coerceInputLiteral()`
* instead.
*
* | GraphQL Value | JSON Value |
* | -------------------- | ------------- |
* | Input Object | Object |
* | List | Array |
* | Boolean | Boolean |
* | String | String |
* | Int / Float | Number |
* | Enum Value | Unknown |
* | NullValue | null |
* @param valueNode - GraphQL value AST node to convert.
* @param type - The GraphQL type to inspect.
* @param variables - Optional runtime variable values keyed by variable name.
* @returns The coerced JavaScript value, or undefined if the AST value cannot be coerced to the type.
* @example
* ```ts
* // Coerce literal values without variables.
* import { parseValue } from 'graphql/language';
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* } from 'graphql/type';
* import { valueFromAST } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* tags: { type: new GraphQLList(GraphQLString) },
* },
* });
*
* valueFromAST(parseValue('{ stars: 5, tags: ["featured"] }'), ReviewInput); // => { stars: 5, tags: ['featured'] }
* valueFromAST(parseValue('{ stars: "bad" }'), ReviewInput); // => undefined
* ```
* @example
* ```ts
* // This variant resolves variable references from runtime values.
* import { parseValue } from 'graphql/language';
* import { GraphQLInt } from 'graphql/type';
* import { valueFromAST } from 'graphql/utilities';
*
* valueFromAST(parseValue('$stars'), GraphQLInt, { stars: 5 }); // => 5
* valueFromAST(parseValue('$stars'), GraphQLInt, {}); // => undefined
* ```
* @deprecated use `coerceInputLiteral()` instead - will be removed in v18
*/
export declare function valueFromAST(valueNode: Maybe<ValueNode>, type: GraphQLInputType, variables?: Maybe<ObjMap<unknown>>): unknown;
/**
* Produces a JavaScript value given a GraphQL Value AST.
*
* Because no GraphQL type is provided, the returned JavaScript value reflects
* the provided GraphQL value AST.
*
* | GraphQL Value | JavaScript Value |
* | -------------------- | ---------------- |
* | Input Object | Object |
* | List | Array |
* | Boolean | Boolean |
* | String / Enum | String |
* | Int / Float | Number |
* | Null | null |
* @param valueNode - GraphQL value AST node to convert.
* @param variables - Optional runtime variable values keyed by variable name.
* @returns JavaScript value represented by the GraphQL value AST.
* @example
* ```ts
* import { parseValue } from 'graphql/language';
* import { valueFromASTUntyped } from 'graphql/utilities';
*
* const value = valueFromASTUntyped(parseValue('[1, 2, 3]'));
*
* value; // => [1, 2, 3]
* valueFromASTUntyped(parseValue('$name'), { name: 'Ada' }); // => 'Ada'
* ```
*/
export declare function valueFromASTUntyped(valueNode: ValueNode, variables?: Maybe<ObjMap<unknown>>): unknown;
/**
* Produces a GraphQL Value AST given a JavaScript object.
* Function will match JavaScript/JSON values to GraphQL AST schema format
* by using suggested GraphQLInputType.
*
* A GraphQL type must be provided, which will be used to interpret different
* JavaScript values.
*
* This deprecated function will be removed in v18. Use `valueToLiteral()`
* instead, and take care to operate on external values.
*
* | JSON Value | GraphQL Value |
* | ------------- | -------------------- |
* | Object | Input Object |
* | Array | List |
* | Boolean | Boolean |
* | String | String / Enum Value |
* | Number | Int / Float |
* | BigInt | Int |
* | Unknown | Enum Value |
* | null | NullValue |
* @param value - Runtime value to convert.
* @param type - The GraphQL type to inspect.
* @returns A GraphQL value AST for the provided JavaScript value, or null when no literal can represent it.
* @example
* ```ts
* import { print } from 'graphql/language';
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* } from 'graphql/type';
* import { astFromValue } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* tags: { type: new GraphQLList(GraphQLString) },
* },
* });
*
* const valueNode = astFromValue(
* { stars: 5, tags: ['featured', 'verified'] },
* ReviewInput,
* );
*
* print(valueNode); // => '{ stars: 5, tags: ["featured", "verified"] }'
* astFromValue(undefined, GraphQLString); // => null
* astFromValue(null, new GraphQLNonNull(GraphQLString)); // => null
* ```
* @deprecated use `valueToLiteral()` instead with care to operate on external values - `astFromValue()` will be removed in v18
*/
export declare function astFromValue(value: unknown, type: GraphQLInputType): Maybe<ConstValueNode>;
/**
* Replaces any Variables found within an AST Value literal with literals
* supplied from a map of variable values, or removed if no variable replacement
* exists, returning a constant value.
*
* Used primarily to ensure only complete constant values are used during input
* coercion of custom scalars which accept complex literals.
* @param valueNode - Value AST node in which variables should be replaced.
* @param variableValues - Operation variable values returned by getVariableValues.
* @param fragmentVariableValues - Fragment variable values for the current fragment scope.
* @returns A constant value AST with variables replaced.
* @example
* ```ts
* import assert from 'node:assert';
* import { parse, parseValue, print } from 'graphql/language';
* import { getVariableValues } from 'graphql/execution';
* import { buildSchema, replaceVariables } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* review(stars: Int = 5): String
* }
* `);
* const document = parse('query ($stars: Int = 5) { review(stars: $stars) }');
* const operation = document.definitions[0];
* const result = getVariableValues(schema, operation.variableDefinitions, {
* stars: 4,
* });
*
* assert('variableValues' in result);
*
* const literal = replaceVariables(
* parseValue('{ stars: $stars, comment: $missing }'),
* result.variableValues,
* );
*
* print(literal); // => '{ stars: 4 }'
* ```
*/
export declare function replaceVariables(valueNode: ValueNode, variableValues?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>): ConstValueNode;
/**
* Produces a GraphQL Value AST given a JavaScript value and a GraphQL type.
*
* Scalar types are converted by calling the `valueToLiteral` method on that
* type, otherwise the default scalar `valueToLiteral` method is used, defined
* below.
*
* Provided value is a non-coerced "input" value. This function does not
* perform any coercion, however it does perform validation. Provided values
* which are invalid for the given type will result in an `undefined` return
* value.
* @param value - JavaScript value to convert.
* @param type - GraphQL input type to convert the value against.
* @returns A GraphQL value AST, or undefined if the value is invalid.
* @example
* ```ts
* import { print } from 'graphql/language';
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* } from 'graphql/type';
* import { valueToLiteral } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* tags: { type: new GraphQLList(GraphQLString) },
* },
* });
*
* const literal = valueToLiteral({ stars: 5, tags: ['featured'] }, ReviewInput);
*
* print(literal); // => '{ stars: 5, tags: ["featured"] }'
* valueToLiteral({ tags: ['missing stars'] }, ReviewInput); // => undefined
* ```
*/
export declare function valueToLiteral(value: unknown, type: GraphQLInputType): ConstValueNode | undefined;
/**
* Coerces a JavaScript value given a GraphQL Input Type.
*
* Returns `undefined` when the value could not be validly coerced according to
* the provided type. Use `validateInputValue` when coercion diagnostics
* are needed.
* @param inputValue - JavaScript value to coerce.
* @param type - GraphQL input type to coerce the value against.
* @returns Coerced value, or undefined if coercion fails.
* @example
* ```ts
* // Coerce runtime input values, returning undefined when coercion fails.
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLList,
* GraphQLNonNull,
* GraphQLString,
* } from 'graphql/type';
* import { coerceInputValue } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* tags: { type: new GraphQLList(GraphQLString) },
* },
* });
*
* coerceInputValue({ stars: '5', tags: ['featured'] }, ReviewInput); // => { stars: 5, tags: ['featured'] }
* coerceInputValue({ stars: 'bad' }, ReviewInput); // => undefined
* ```
*/
export declare function coerceInputValue(inputValue: unknown, type: GraphQLInputType): unknown;
/**
* Produces a coerced "internal" JavaScript value given a GraphQL Value AST.
*
* Returns `undefined` when the value could not be validly coerced according to
* the provided type.
* @param valueNode - GraphQL value AST node to coerce.
* @param type - GraphQL input type to coerce the literal against.
* @param variableValues - Operation variable values returned by getVariableValues.
* @param fragmentVariableValues - Fragment variable values for the current fragment scope.
* @returns Coerced value, or undefined if coercion fails.
* @example
* ```ts
* // Coerce literal input values without variables.
* import { parseValue } from 'graphql/language';
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLNonNull,
* GraphQLString,
* } from 'graphql/type';
* import { coerceInputLiteral } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* comment: { type: GraphQLString },
* },
* });
*
* coerceInputLiteral(
* parseValue('{ stars: 5, comment: "Loved it" }'),
* ReviewInput,
* ); // => { stars: 5, comment: 'Loved it' }
* coerceInputLiteral(parseValue('{ comment: "Missing" }'), ReviewInput); // => undefined
* ```
* @example
* ```ts
* // This variant resolves variable references using VariableValues from getVariableValues().
* import assert from 'node:assert';
* import { parse, parseValue } from 'graphql/language';
* import { GraphQLInt } from 'graphql/type';
* import { getVariableValues } from 'graphql/execution';
* import { buildSchema, coerceInputLiteral } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* review(stars: Int): String
* }
* `);
* const document = parse('query ($stars: Int = 5) { review(stars: $stars) }');
* const operation = document.definitions[0];
* const result = getVariableValues(schema, operation.variableDefinitions, {
* stars: '4',
* });
*
* assert('variableValues' in result);
*
* coerceInputLiteral(parseValue('$stars'), GraphQLInt, result.variableValues); // => 4
* ```
*/
export declare function coerceInputLiteral(valueNode: ValueNode, type: GraphQLInputType, variableValues?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>): unknown;
/**
* Validate that the provided input value is allowed for this type, collecting
* all errors via a callback function.
* @param inputValue - JavaScript value to validate.
* @param type - GraphQL input type to validate the value against.
* @param onError - Callback invoked for each validation error and path.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns Nothing.
* @example
* ```ts
* // Collect validation errors with their input paths.
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLNonNull,
* } from 'graphql/type';
* import { validateInputValue } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* },
* });
* const errors = [];
*
* validateInputValue({ stars: 'bad' }, ReviewInput, (error, path) => {
* errors.push({ message: error.message, path });
* });
*
* errors; // => [ { message: 'Expected value of type "Int", found: "bad".', path: ['stars'] } ]
* ```
* @example
* ```ts
* // This variant hides suggestion text for unknown input fields.
* import { GraphQLInputObjectType, GraphQLString } from 'graphql/type';
* import { validateInputValue } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* comment: { type: GraphQLString },
* },
* });
* const errors = [];
*
* validateInputValue(
* { rating: 'extra field' },
* ReviewInput,
* (error) => {
* errors.push(error.message);
* },
* true,
* );
*
* errors; // => ['Expected value of type "ReviewInput" not to include unknown field "rating", found: { rating: "extra field" }.']
* ```
*/
export declare function validateInputValue(inputValue: unknown, type: GraphQLInputType, onError: (error: GraphQLError, path: ReadonlyArray<string | number>) => void, hideSuggestions?: Maybe<boolean>): void;
/**
* Validate that the provided input literal is allowed for this type, collecting
* all errors via a callback function.
*
* If variable values are not provided, the literal is validated statically
* (not assuming that those variables are missing runtime values).
* @param valueNode - GraphQL value AST node to validate.
* @param type - GraphQL input type to validate the literal against.
* @param onError - Callback invoked for each validation error and path.
* @param variables - Operation variable values returned by getVariableValues.
* @param fragmentVariableValues - Fragment variable values for the current fragment scope.
* @param hideSuggestions - Whether suggestion text should be omitted from errors.
* @returns Nothing.
* @example
* ```ts
* // Validate literal input values and collect literal paths.
* import { parseValue } from 'graphql/language';
* import {
* GraphQLInputObjectType,
* GraphQLInt,
* GraphQLNonNull,
* } from 'graphql/type';
* import { validateInputLiteral } from 'graphql/utilities';
*
* const ReviewInput = new GraphQLInputObjectType({
* name: 'ReviewInput',
* fields: {
* stars: { type: new GraphQLNonNull(GraphQLInt) },
* },
* });
* const errors = [];
*
* validateInputLiteral(
* parseValue('{ stars: "bad" }'),
* ReviewInput,
* (error, path) => {
* errors.push({ message: error.message, path });
* },
* );
*
* errors; // => [ { message: 'Expected value of type "Int", found: "bad".', path: ['stars'] } ]
* ```
* @example
* ```ts
* // This variant resolves variable references using VariableValues from getVariableValues().
* import assert from 'node:assert';
* import { parse, parseValue } from 'graphql/language';
* import { GraphQLInt } from 'graphql/type';
* import { getVariableValues } from 'graphql/execution';
* import { buildSchema, validateInputLiteral } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* review(stars: Int): String
* }
* `);
* const document = parse('query ($stars: Int = 5) { review(stars: $stars) }');
* const operation = document.definitions[0];
* const result = getVariableValues(schema, operation.variableDefinitions, {
* stars: '4',
* });
*
* assert('variableValues' in result);
*
* const errors = [];
* validateInputLiteral(
* parseValue('$stars'),
* GraphQLInt,
* (error) => errors.push(error.message),
* result.variableValues,
* undefined,
* true,
* );
*
* errors; // => []
* ```
*/
export declare function validateInputLiteral(valueNode: ValueNode, type: GraphQLInputType, onError: (error: GraphQLError, path: ReadonlyArray<string | number>) => void, variables?: Maybe<VariableValues>, fragmentVariableValues?: Maybe<FragmentVariableValues>, hideSuggestions?: Maybe<boolean>): void;
/**
* Provided a collection of ASTs, presumably each from different files,
* concatenate the ASTs together into batched AST, useful for validating many
* GraphQL source files which together represent one conceptual application.
* @param documents - Document ASTs to concatenate.
* @returns A document AST containing all definitions from the provided documents.
* @example
* ```ts
* import { parse } from 'graphql/language';
* import { concatAST } from 'graphql/utilities';
*
* const document = concatAST([
* parse('type Query { a: String }'),
* parse('type User { id: ID }'),
* ]);
*
* document.definitions.length; // => 2
* ```
*/
export declare function concatAST(documents: ReadonlyArray<DocumentNode>): DocumentNode;
/**
* separateOperations accepts a single AST document which may contain many
* operations and fragments and returns a collection of AST documents each of
* which contains a single operation as well the fragment definitions it
* refers to.
* @param documentAST - The parsed GraphQL document AST.
* @returns A map of operation names to documents containing each operation and its referenced fragments.
* @example
* ```ts
* import { parse, print } from 'graphql/language';
* import { separateOperations } from 'graphql/utilities';
*
* const document = parse(`
* query GetUser {
* viewer {
* ...UserFields
* }
* }
*
* query GetStatus {
* status
* }
*
* fragment UserFields on User {
* id
* }
* `);
*
* const separated = separateOperations(document);
*
* Object.keys(separated); // => ['GetUser', 'GetStatus']
* print(separated.GetUser); // matches /fragment UserFields/
* print(separated.GetStatus); // does not match /fragment UserFields/
* ```
*/
export declare function separateOperations(documentAST: DocumentNode): ObjMap<DocumentNode>;
/**
* Strips characters that are not significant to the validity or execution
* of a GraphQL document:
* - UnicodeBOM
* - WhiteSpace
* - LineTerminator
* - Comment
* - Comma
* - BlockString indentation
*
* Note: It is required to have a delimiter character between neighboring
* non-punctuator tokens and this function always uses single space as delimiter.
*
* It is guaranteed that both input and output documents if parsed would result
* in the exact same AST except for nodes location.
*
* Warning: It is guaranteed that this function will always produce stable results.
* However, it's not guaranteed that it will stay the same between different
* releases due to bugfixes or changes in the GraphQL specification.
* @param source - The GraphQL source text or source object.
* @returns A semantically equivalent GraphQL source string without ignored characters.
* @example Query source
* ```graphql
* query SomeQuery($foo: String!, $bar: String) {
* someField(foo: $foo, bar: $bar) {
* a
* b {
* c
* d
* }
* }
* }
* ```
*
* Becomes:
*
* ```graphql prettier-ignore
* query SomeQuery($foo:String!$bar:String){someField(foo:$foo bar:$bar){a b{c d}}}
* ```
* @example SDL source
* ```graphql
* """
* Type description
* """
* type Foo {
* """
* Field description
* """
* bar: String
* }
* ```
*
* Becomes:
*
* ```graphql prettier-ignore
* """Type description""" type Foo{"""Field description""" bar:String}
* ```
* @example
* ```ts
* import { stripIgnoredCharacters } from 'graphql/utilities';
*
* const source = stripIgnoredCharacters('query Example { name }');
*
* source; // => 'query Example{name}'
* ```
*/
export declare function stripIgnoredCharacters(source: string | Source): string;
/**
* Provided two types, return true if the types are equal (invariant).
* @param typeA - The first GraphQL type to compare.
* @param typeB - The second GraphQL type to compare.
* @returns True when both types are equal.
* @example
* ```ts
* import { GraphQLList, GraphQLNonNull, GraphQLString } from 'graphql/type';
* import { isEqualType } from 'graphql/utilities';
*
* isEqualType(GraphQLString, GraphQLString); // => true
* isEqualType(new GraphQLList(GraphQLString), new GraphQLList(GraphQLString)); // => true
* isEqualType(new GraphQLNonNull(GraphQLString), GraphQLString); // => false
* ```
*/
export declare function isEqualType(typeA: GraphQLType, typeB: GraphQLType): boolean;
/**
* Provided a type and a super type, return true if the first type is either
* equal or a subset of the second super type (covariant).
* @param schema - GraphQL schema to use.
* @param maybeSubType - The possible subtype to compare.
* @param superType - The possible supertype to compare.
* @returns True when `maybeSubType` is equal to or a subtype of `superType`.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import {
* GraphQLNonNull,
* assertInterfaceType,
* assertObjectType,
* } from 'graphql/type';
* import { isTypeSubTypeOf } from 'graphql/utilities';
*
* const schema = buildSchema(`
* interface Node {
* id: ID!
* }
*
* type User implements Node {
* id: ID!
* }
*
* type Query {
* node: Node
* }
* `);
* const Node = assertInterfaceType(schema.getType('Node'));
* const User = assertObjectType(schema.getType('User'));
*
* isTypeSubTypeOf(schema, User, Node); // => true
* isTypeSubTypeOf(schema, new GraphQLNonNull(User), Node); // => true
* isTypeSubTypeOf(schema, Node, User); // => false
* ```
*/
export declare function isTypeSubTypeOf(schema: GraphQLSchema, maybeSubType: GraphQLType, superType: GraphQLType): boolean;
/**
* Provided two composite types, determine if they "overlap". Two composite
* types overlap when the Sets of possible concrete types for each intersect.
*
* This is often used to determine if a fragment of a given type could possibly
* be visited in a context of another type.
*
* This function is commutative.
* @param schema - GraphQL schema to use.
* @param typeA - The first GraphQL type to compare.
* @param typeB - The second GraphQL type to compare.
* @returns True when the two composite types can apply to at least one common object type.
* @example
* ```ts
* import { buildSchema } from 'graphql/utilities';
* import { assertObjectType, assertUnionType } from 'graphql/type';
* import { doTypesOverlap } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Photo {
* url: String!
* }
*
* type Video {
* url: String!
* }
*
* union Media = Photo | Video
* union StillImage = Photo
*
* type Query {
* media: [Media]
* }
* `);
* const Media = assertUnionType(schema.getType('Media'));
* const StillImage = assertUnionType(schema.getType('StillImage'));
* const Video = assertObjectType(schema.getType('Video'));
*
* doTypesOverlap(schema, Media, StillImage); // => true
* doTypesOverlap(schema, StillImage, Video); // => false
* ```
*/
export declare function doTypesOverlap(schema: GraphQLSchema, typeA: GraphQLCompositeType, typeB: GraphQLCompositeType): boolean;
/** Categories of schema changes that may break existing operations. */
export declare const BreakingChangeType: {
readonly TYPE_REMOVED: "TYPE_REMOVED";
readonly TYPE_CHANGED_KIND: "TYPE_CHANGED_KIND";
readonly TYPE_REMOVED_FROM_UNION: "TYPE_REMOVED_FROM_UNION";
readonly VALUE_REMOVED_FROM_ENUM: "VALUE_REMOVED_FROM_ENUM";
readonly REQUIRED_INPUT_FIELD_ADDED: "REQUIRED_INPUT_FIELD_ADDED";
readonly IMPLEMENTED_INTERFACE_REMOVED: "IMPLEMENTED_INTERFACE_REMOVED";
readonly FIELD_REMOVED: "FIELD_REMOVED";
readonly FIELD_CHANGED_KIND: "FIELD_CHANGED_KIND";
readonly REQUIRED_ARG_ADDED: "REQUIRED_ARG_ADDED";
readonly ARG_REMOVED: "ARG_REMOVED";
readonly ARG_CHANGED_KIND: "ARG_CHANGED_KIND";
readonly DIRECTIVE_REMOVED: "DIRECTIVE_REMOVED";
readonly DIRECTIVE_ARG_REMOVED: "DIRECTIVE_ARG_REMOVED";
readonly REQUIRED_DIRECTIVE_ARG_ADDED: "REQUIRED_DIRECTIVE_ARG_ADDED";
readonly DIRECTIVE_REPEATABLE_REMOVED: "DIRECTIVE_REPEATABLE_REMOVED";
readonly DIRECTIVE_LOCATION_REMOVED: "DIRECTIVE_LOCATION_REMOVED";
};
/** Categories of schema changes that may break existing operations. */
export type BreakingChangeType = (typeof BreakingChangeType)[keyof typeof BreakingChangeType];
/** Categories of schema changes that may be dangerous for existing operations. */
export declare const DangerousChangeType: {
readonly VALUE_ADDED_TO_ENUM: "VALUE_ADDED_TO_ENUM";
readonly TYPE_ADDED_TO_UNION: "TYPE_ADDED_TO_UNION";
readonly OPTIONAL_INPUT_FIELD_ADDED: "OPTIONAL_INPUT_FIELD_ADDED";
readonly OPTIONAL_ARG_ADDED: "OPTIONAL_ARG_ADDED";
readonly IMPLEMENTED_INTERFACE_ADDED: "IMPLEMENTED_INTERFACE_ADDED";
readonly ARG_DEFAULT_VALUE_CHANGE: "ARG_DEFAULT_VALUE_CHANGE";
readonly INPUT_FIELD_DEFAULT_VALUE_CHANGE: "INPUT_FIELD_DEFAULT_VALUE_CHANGE";
};
/** Categories of schema changes that may be dangerous for existing operations. */
export type DangerousChangeType = (typeof DangerousChangeType)[keyof typeof DangerousChangeType];
/** Categories of schema changes that are considered safe for existing operations. */
export declare const SafeChangeType: {
readonly DESCRIPTION_CHANGED: "DESCRIPTION_CHANGED";
readonly TYPE_ADDED: "TYPE_ADDED";
readonly OPTIONAL_INPUT_FIELD_ADDED: "OPTIONAL_INPUT_FIELD_ADDED";
readonly OPTIONAL_ARG_ADDED: "OPTIONAL_ARG_ADDED";
readonly DIRECTIVE_ADDED: "DIRECTIVE_ADDED";
readonly FIELD_ADDED: "FIELD_ADDED";
readonly DIRECTIVE_REPEATABLE_ADDED: "DIRECTIVE_REPEATABLE_ADDED";
readonly DIRECTIVE_LOCATION_ADDED: "DIRECTIVE_LOCATION_ADDED";
readonly OPTIONAL_DIRECTIVE_ARG_ADDED: "OPTIONAL_DIRECTIVE_ARG_ADDED";
readonly FIELD_CHANGED_KIND_SAFE: "FIELD_CHANGED_KIND_SAFE";
readonly ARG_CHANGED_KIND_SAFE: "ARG_CHANGED_KIND_SAFE";
readonly ARG_DEFAULT_VALUE_ADDED: "ARG_DEFAULT_VALUE_ADDED";
readonly INPUT_FIELD_DEFAULT_VALUE_ADDED: "INPUT_FIELD_DEFAULT_VALUE_ADDED";
};
/** Categories of schema changes that are considered safe for existing operations. */
export type SafeChangeType = (typeof SafeChangeType)[keyof typeof SafeChangeType];
/** Description of a schema change that may break existing operations. */
export interface BreakingChange {
/** Specific kind of breaking schema change. */
type: BreakingChangeType;
/** Human-readable description of the breaking schema change. */
description: string;
}
/** Description of a schema change that may be dangerous for existing operations. */
export interface DangerousChange {
/** Specific kind of dangerous schema change. */
type: DangerousChangeType;
/** Human-readable description of the dangerous schema change. */
description: string;
}
/** Description of a schema change that is considered safe for existing operations. */
export interface SafeChange {
/** Specific kind of safe schema change. */
type: SafeChangeType;
/** Human-readable description of the safe schema change. */
description: string;
}
/** Any schema change detected between two schemas. */
export type SchemaChange = SafeChange | DangerousChange | BreakingChange;
/**
* Given two schemas, returns an Array containing descriptions of all the types
* of breaking changes covered by the other functions down below. This
* deprecated wrapper will be removed in v18; use `findSchemaChanges()` instead
* and filter for breaking changes.
* @param oldSchema - Schema before the change.
* @param newSchema - Schema after the change.
* @returns Breaking changes between the two schemas.
* @example
* ```ts
* import { buildSchema, findBreakingChanges } from 'graphql/utilities';
*
* const oldSchema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const newSchema = buildSchema(`
* type Query {
* hello: String
* }
* `);
*
* const changes = findBreakingChanges(oldSchema, newSchema);
*
* changes.map((change) => change.type); // => ['FIELD_REMOVED']
* ```
* @deprecated Please use `findSchemaChanges` instead. Will be removed in v18.
*/
export declare function findBreakingChanges(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Array<BreakingChange>;
/**
* Given two schemas, returns an Array containing descriptions of all the types
* of potentially dangerous changes covered by the other functions down below.
* This deprecated wrapper will be removed in v18; use `findSchemaChanges()`
* instead and filter for dangerous changes.
* @param oldSchema - Schema before the change.
* @param newSchema - Schema after the change.
* @returns Dangerous changes between the two schemas.
* @example
* ```ts
* import { buildSchema, findDangerousChanges } from 'graphql/utilities';
*
* const oldSchema = buildSchema(`
* enum Episode {
* NEW_HOPE
* }
*
* type Query {
* episode: Episode
* }
* `);
* const newSchema = buildSchema(`
* enum Episode {
* NEW_HOPE
* EMPIRE
* }
*
* type Query {
* episode: Episode
* }
* `);
*
* const changes = findDangerousChanges(oldSchema, newSchema);
*
* changes.map((change) => change.type); // => ['VALUE_ADDED_TO_ENUM']
* ```
* @deprecated Please use `findSchemaChanges` instead. Will be removed in v18.
*/
export declare function findDangerousChanges(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Array<DangerousChange>;
/**
* Finds all schema changes between two schemas.
* @param oldSchema - Schema before the change.
* @param newSchema - Schema after the change.
* @returns Safe, dangerous, and breaking changes between the two schemas.
* @example
* ```ts
* import { buildSchema, findSchemaChanges } from 'graphql/utilities';
*
* const oldSchema = buildSchema(`
* type Query {
* greeting: String
* }
* `);
* const newSchema = buildSchema(`
* type Query {
* greeting(name: String): String
* farewell: String
* }
* `);
*
* const changes = findSchemaChanges(oldSchema, newSchema);
*
* changes.map((change) => change.type); // => ['OPTIONAL_ARG_ADDED', 'FIELD_ADDED']
* ```
*/
export declare function findSchemaChanges(oldSchema: GraphQLSchema, newSchema: GraphQLSchema): Array<SchemaChange>;
/**
* Wrapper type that contains DocumentNode and types that can be deduced from it.
* @typeParam TResponseData - Typed GraphQL response data shape.
* @typeParam TRequestVariables - Typed GraphQL request variables shape.
*/
export interface TypedQueryDocumentNode<TResponseData = {
[key: string]: any;
}, TRequestVariables = {
[key: string]: any;
}> extends DocumentNode {
/** Top-level executable and type-system definitions in this document. */
readonly definitions: ReadonlyArray<ExecutableDefinitionNode>;
/**
* This type is used to ensure that the variables you pass in to the query are assignable to Variables
* and that the Result is assignable to whatever you pass your result to. The method is never actually
* implemented, but the type is valid because we list it as optional
*/
__ensureTypesOfVariablesAndResultMatching?: (variables: TRequestVariables) => TResponseData;
}
interface ResolvedNamedType {
readonly kind: "NamedType";
readonly type: GraphQLNamedType;
}
interface ResolvedField {
readonly kind: "Field";
readonly type: GraphQLObjectType | GraphQLInterfaceType;
readonly field: GraphQLField<unknown, unknown>;
}
interface ResolvedInputField {
readonly kind: "InputField";
readonly type: GraphQLInputObjectType;
readonly inputField: GraphQLInputField;
}
interface ResolvedEnumValue {
readonly kind: "EnumValue";
readonly type: GraphQLEnumType;
readonly enumValue: GraphQLEnumValue;
}
interface ResolvedFieldArgument {
readonly kind: "FieldArgument";
readonly type: GraphQLObjectType | GraphQLInterfaceType;
readonly field: GraphQLField<unknown, unknown>;
readonly fieldArgument: GraphQLArgument;
}
interface ResolvedDirective {
readonly kind: "Directive";
readonly directive: GraphQLDirective;
}
interface ResolvedDirectiveArgument {
readonly kind: "DirectiveArgument";
readonly directive: GraphQLDirective;
readonly directiveArgument: GraphQLArgument;
}
/** A schema element resolved from a schema coordinate. */
export type ResolvedSchemaElement = ResolvedNamedType | ResolvedField | ResolvedInputField | ResolvedEnumValue | ResolvedFieldArgument | ResolvedDirective | ResolvedDirectiveArgument;
/**
* A schema coordinate is resolved in the context of a GraphQL schema to
* uniquely identify a schema element. It returns undefined if the schema
* coordinate does not resolve to a schema element, meta-field, or introspection
* schema element. It will throw if the containing schema element (if
* applicable) does not exist.
*
* https://spec.graphql.org/draft/#sec-Schema-Coordinates.Semantics
* @param schema - GraphQL schema to use.
* @param schemaCoordinate - The schema coordinate to resolve.
* @returns The schema element identified by the coordinate, or undefined if none exists.
* @example
* ```ts
* import { buildSchema, resolveSchemaCoordinate } from 'graphql/utilities';
*
* const schema = buildSchema(`
* directive @tag(name: String!) on FIELD_DEFINITION
*
* input ReviewInput {
* stars: Int!
* }
*
* enum Episode {
* NEW_HOPE
* }
*
* type Query {
* reviews(input: ReviewInput): [String] @tag(name: "reviews")
* }
* `);
*
* resolveSchemaCoordinate(schema, 'Query').kind; // => 'NamedType'
* resolveSchemaCoordinate(schema, 'Query.reviews').kind; // => 'Field'
* resolveSchemaCoordinate(schema, 'Query.reviews(input:)').kind; // => 'FieldArgument'
* resolveSchemaCoordinate(schema, 'ReviewInput.stars').kind; // => 'InputField'
* resolveSchemaCoordinate(schema, 'Episode.NEW_HOPE').kind; // => 'EnumValue'
* resolveSchemaCoordinate(schema, '@tag').kind; // => 'Directive'
* resolveSchemaCoordinate(schema, '@tag(name:)').kind; // => 'DirectiveArgument'
* resolveSchemaCoordinate(schema, 'Query.missing'); // => undefined
* ```
*/
export declare function resolveSchemaCoordinate(schema: GraphQLSchema, schemaCoordinate: string | Source): ResolvedSchemaElement | undefined;
/**
* Resolves schema coordinate from a parsed SchemaCoordinate node.
* @param schema - GraphQL schema to use.
* @param schemaCoordinate - The schema coordinate to resolve.
* @returns The schema element identified by the parsed coordinate, or undefined if none exists.
* @example
* ```ts
* import { parseSchemaCoordinate } from 'graphql/language';
* import { buildSchema, resolveASTSchemaCoordinate } from 'graphql/utilities';
*
* const schema = buildSchema(`
* type Query {
* greeting(name: String): String
* }
* `);
* const coordinate = parseSchemaCoordinate('Query.greeting(name:)');
* const resolved = resolveASTSchemaCoordinate(schema, coordinate);
*
* resolved.kind; // => 'FieldArgument'
* resolved.field.name; // => 'greeting'
* resolved.fieldArgument.name; // => 'name'
* ```
*/
export declare function resolveASTSchemaCoordinate(schema: GraphQLSchema, schemaCoordinate: SchemaCoordinateNode): ResolvedSchemaElement | undefined;
type ExtensionsObject = Record<string | symbol, any>;
type ObjectTypeExtensions = {
type: "object";
fields: Record<string, {
extensions: ExtensionsObject;
arguments: Record<string, ExtensionsObject>;
}>;
};
type InputTypeExtensions = {
type: "input";
fields: Record<string, {
extensions: ExtensionsObject;
}>;
};
type InterfaceTypeExtensions = {
type: "interface";
fields: Record<string, {
extensions: ExtensionsObject;
arguments: Record<string, ExtensionsObject>;
}>;
};
type UnionTypeExtensions = {
type: "union";
};
type ScalarTypeExtensions = {
type: "scalar";
};
type EnumTypeExtensions = {
type: "enum";
values: Record<string, ExtensionsObject>;
};
type PossibleTypeExtensions = InputTypeExtensions | InterfaceTypeExtensions | ObjectTypeExtensions | UnionTypeExtensions | ScalarTypeExtensions | EnumTypeExtensions;
type SchemaExtensions = {
schemaExtensions: ExtensionsObject;
types: Record<string, {
extensions: ExtensionsObject;
} & PossibleTypeExtensions>;
};
interface GraphQLResolveInfo$1 extends GraphQLResolveInfo {
signal?: AbortSignal;
/** Returns the AbortSignal supplied for this execution, if any. */
readonly getAbortSignal: () => AbortSignal | undefined;
/** Returns helper functions for tracking asynchronous resolver work. */
readonly getAsyncHelpers: () => GraphQLResolveInfoHelpers$1;
}
interface GraphQLResolveInfoHelpers$1 {
/**
* Promise.all wrapper that allows rejected branches to be tracked
* as execution async work.
*
* Intended use: return or await this promise from resolver work.
* Un-awaited async side effects are an anti-pattern:
*
* const { promiseAll } = info.getAsyncHelpers();
* promiseAll([someAsyncWork(), someOtherAsyncWork()]).catch(() => undefined);
*
* In that anti-pattern, tracking starts only after rejection (on a
* later microtask), so this work is not guaranteed to delay
* `hooks.asyncWorkFinished`.
*
* Use `track(...)` for un-awaited async side effects:
*
* const { track } = info.getAsyncHelpers();
* track([
* someAsyncWork().catch(() => undefined),
* someOtherAsyncWork().catch(() => undefined)
* ]);
*/
readonly promiseAll: <T>(values: ReadonlyArray<PromiseLike<T> | T>) => Promise<Array<T>>;
/** Tracks asynchronous work that should delay execution completion hooks. */
readonly track: (maybePromises: ReadonlyArray<unknown>) => void;
}
interface GraphQLParseOptions {
noLocation?: boolean;
allowLegacySDLEmptyFields?: boolean;
allowLegacySDLImplementsInterfaces?: boolean;
experimentalFragmentVariables?: boolean;
/**
* Set to `true` in order to convert all GraphQL comments (marked with # sign) to descriptions (""")
* GraphQL has built-in support for transforming descriptions to comments (with `print`), but not while
* parsing. Turning the flag on will support the other way as well (`parse`)
*/
commentDescriptions?: boolean;
}
type ValidatorBehavior = "error" | "warn" | "ignore";
interface IResolverValidationOptions {
/**
* Enable to require a resolver to be defined for any field that has
* arguments. Defaults to `ignore`.
*/
requireResolversForArgs?: ValidatorBehavior;
/**
* Enable to require a resolver to be defined for any field which has
* a return type that isn't a scalar. Defaults to `ignore`.
*/
requireResolversForNonScalar?: ValidatorBehavior;
/**
* Enable to require a resolver for be defined for all fields defined
* in the schema. Defaults to `ignore`.
*/
requireResolversForAllFields?: ValidatorBehavior;
/**
* Enable to require a `resolveType()` for Interface and Union types.
* Defaults to `ignore`.
*/
requireResolversForResolveType?: ValidatorBehavior;
/**
* Enable to require all defined resolvers to match fields that
* actually exist in the schema. Defaults to `error` to catch common errors.
*/
requireResolversToMatchSchema?: ValidatorBehavior;
}
type IScalarTypeResolver = GraphQLScalarType & {
__name?: string;
__description?: string;
__serialize?: GraphQLScalarSerializer<any>;
__parseValue?: GraphQLScalarValueParser<any>;
__parseLiteral?: GraphQLScalarLiteralParser<any>;
__extensions?: ExtensionsObject;
__astNode?: ScalarTypeDefinitionNode;
__extensionASTNodes?: Array<ScalarTypeExtensionNode>;
};
type IEnumTypeResolver = Record<string, any> & {
__name?: string;
__description?: string;
__extensions?: ExtensionsObject;
__astNode?: EnumTypeDefinitionNode;
__extensionASTNodes?: Array<EnumTypeExtensionNode>;
};
interface IFieldResolverOptions<TSource = any, TContext = any, TArgs = any> {
name?: string;
description?: string;
type?: GraphQLOutputType;
args?: Array<GraphQLArgument>;
resolve?: IFieldResolver<TSource, TContext, TArgs>;
subscribe?: IFieldResolver<TSource, TContext, TArgs>;
isDeprecated?: boolean;
deprecationReason?: string;
extensions?: ExtensionsObject;
astNode?: FieldDefinitionNode;
}
type IFieldResolver<TSource, TContext, TArgs = Record<string, any>, TReturn = any> = (source: TSource, args: TArgs, context: TContext, info: GraphQLResolveInfo$1) => TReturn;
type TypeSource = string | Source | DocumentNode | GraphQLSchema | DefinitionNode | Array<TypeSource> | (() => TypeSource);
type IObjectTypeResolver<TSource = any, TContext = any, TArgs = any> = {
[key: string]: IFieldResolver<TSource, TContext, TArgs> | IFieldResolverOptions<TSource, TContext>;
} & {
__name?: string;
__description?: string;
__isTypeOf?: GraphQLIsTypeOfFn<TSource, TContext>;
__extensions?: ExtensionsObject;
__astNode?: ObjectTypeDefinitionNode;
__extensionASTNodes?: ObjectTypeExtensionNode;
};
type IInterfaceTypeResolver<TSource = any, TContext = any, TArgs = any> = {
[key: string]: IFieldResolver<TSource, TContext, TArgs> | IFieldResolverOptions<TSource, TContext>;
} & {
__name?: string;
__description?: string;
__resolveType?: GraphQLTypeResolver<any, any>;
__extensions?: ExtensionsObject;
__astNode?: InterfaceTypeDefinitionNode;
__extensionASTNodes?: Array<InterfaceTypeExtensionNode>;
};
type IUnionTypeResolver = {
__name?: string;
__description?: string;
__resolveType?: GraphQLTypeResolver<any, any>;
__extensions?: ExtensionsObject;
__astNode?: UnionTypeDefinitionNode;
__extensionASTNodes?: Array<UnionTypeExtensionNode>;
};
type IInputObjectTypeResolver = {
__name?: string;
__description?: string;
__extensions?: ExtensionsObject;
__astNode?: InputObjectTypeDefinitionNode;
__extensionASTNodes?: Array<InputObjectTypeExtensionNode>;
};
type ISchemaLevelResolver<TSource, TContext, TArgs = Record<string, any>, TReturn = any> = IFieldResolver<TSource, TContext, TArgs, TReturn>;
type IResolvers<TSource = any, TContext = any, TArgs = Record<string, any>, TReturn = any> = Record<string, ISchemaLevelResolver<TSource, TContext, TArgs, TReturn> | IObjectTypeResolver<TSource, TContext> | IInterfaceTypeResolver<TSource, TContext> | IUnionTypeResolver | IScalarTypeResolver | IEnumTypeResolver | IInputObjectTypeResolver>;
export interface GraphQLError {
/**
* An optional schema coordinate (e.g. "MyType.myField") associated with this error.
*/
readonly coordinate?: string;
}
interface IExecutableSchemaDefinition<TContext = any> extends BuildSchemaOptions, GraphQLParseOptions {
/**
* The type definitions used to create the schema
*/
typeDefs: TypeSource;
/**
* Object describing the field resolvers for the provided type definitions
*/
resolvers?: IResolvers<any, TContext> | Array<IResolvers<any, TContext>>;
/**
* Additional options for validating the provided resolvers
*/
resolverValidationOptions?: IResolverValidationOptions;
/**
* GraphQL object types that implement interfaces will inherit any missing
* resolvers from their interface types defined in the `resolvers` object
*/
inheritResolversFromInterfaces?: boolean;
/**
* Do not create a schema again and use the one from `buildASTSchema`
*/
updateResolversInPlace?: boolean;
/**
* Schema extensions
*/
schemaExtensions?: SchemaExtensions | Array<SchemaExtensions>;
/**
* Default field resolver
*/
defaultFieldResolver?: GraphQLFieldResolver<any, TContext>;
}
/**
* Builds a schema from the provided type definitions and resolvers.
*
* The type definitions are written using Schema Definition Language (SDL). They
* can be provided as a string, a `DocumentNode`, a function, or an array of any
* of these. If a function is provided, it will be passed no arguments and
* should return an array of strings or `DocumentNode`s.
*
* Note: You can use GraphQL magic comment provide additional syntax
* highlighting in your editor (with the appropriate editor plugin).
*
* ```js
* const typeDefs = /* GraphQL *\/ `
* type Query {
* posts: [Post]
* author(id: Int!): Author
* }
* `;
* ```
*
* The `resolvers` object should be a map of type names to nested object, which
* themselves map the type's fields to their appropriate resolvers.
* See the [Resolvers](/docs/resolvers) section of the documentation for more details.
*
* ```js
* const resolvers = {
* Query: {
* posts: (obj, args, ctx, info) => getAllPosts(),
* author: (obj, args, ctx, info) => getAuthorById(args.id)
* }
* };
* ```
*
* Once you've defined both the `typeDefs` and `resolvers`, you can create your
* schema:
*
* ```js
* const schema = makeExecutableSchema({
* typeDefs,
* resolvers,
* })
* ```
*/
export declare function makeExecutableSchema<TContext = any>({ typeDefs, resolvers, resolverValidationOptions, inheritResolversFromInterfaces, updateResolversInPlace, schemaExtensions, defaultFieldResolver, ...otherOptions }: IExecutableSchemaDefinition<TContext>): GraphQLSchema;
type ID = string;
declare enum MessageType {
ConnectionInit = "connection_init",// Client -> Server
ConnectionAck = "connection_ack",// Server -> Client
Ping = "ping",// bidirectional
Pong = "pong",/// bidirectional
Subscribe = "subscribe",// Client -> Server
Next = "next",// Server -> Client
Error = "error",// Server -> Client
Complete = "complete"
}
interface ConnectionInitMessage {
readonly type: MessageType.ConnectionInit;
readonly payload?: Record<string, unknown>;
}
interface PingMessage {
readonly type: MessageType.Ping;
readonly payload?: Record<string, unknown>;
}
interface PongMessage {
readonly type: MessageType.Pong;
readonly payload?: Record<string, unknown>;
}
interface SubscribePayload {
readonly operationName?: string | null | undefined;
readonly query: string;
readonly variables?: Record<string, unknown> | null | undefined;
readonly extensions?: Record<string, unknown> | null | undefined;
}
interface ExecutionResult$1<Data = Record<string, unknown>, Extensions = Record<string, unknown>> {
errors?: ReadonlyArray<GraphQLError> | undefined;
data?: Data | null | undefined;
hasNext?: boolean | undefined;
extensions?: Extensions | undefined;
}
type JSONMessageReviver = (this: any, key: string, value: any) => any;
type JSONMessageReplacer = (this: any, key: string, value: any) => any;
type OperationResult = Promise<AsyncGenerator<ExecutionResult$1> | AsyncIterable<ExecutionResult$1> | ExecutionResult$1> | AsyncGenerator<ExecutionResult$1> | AsyncIterable<ExecutionResult$1> | ExecutionResult$1;
type GraphQLExecutionContextValue = object | symbol | number | string | boolean | undefined | null;
/** @category Server */
export interface ServerOptions<P extends ConnectionInitMessage["payload"] = ConnectionInitMessage["payload"], E = unknown> {
/**
* The GraphQL schema on which the operations
* will be executed and validated against.
*
* If a function is provided, it will be called on
* every subscription request allowing you to manipulate
* schema dynamically.
*
* If the schema is left undefined, you're trusted to
* provide one in the returned `ExecutionArgs` from the
* `onSubscribe` callback.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
schema?: undefined | GraphQLSchema | ((ctx: Context<P, E>, id: string, payload: SubscribePayload, args: Omit<ExecutionArgs, "schema">) => Promise<GraphQLSchema> | GraphQLSchema);
/**
* A value which is provided to every resolver and holds
* important contextual information like the currently
* logged in user, or access to a database.
*
* If you return from `onSubscribe`, and the returned value is
* missing the `contextValue` field, this context will be used
* instead.
*
* If you use the function signature, the final execution arguments
* will be passed in (also the returned value from `onSubscribe`).
* Since the context is injected on every subscribe, the `SubscribeMessage`
* with the regular `Context` will be passed in through the arguments too.
*
* Note that the context function is invoked on each operation only once.
* Meaning, for subscriptions, only at the point of initialising the subscription;
* not on every subscription event emission. Read more about the context lifecycle
* in subscriptions here: https://github.com/graphql/graphql-js/issues/894.
*/
context?: undefined | GraphQLExecutionContextValue | ((ctx: Context<P, E>, id: string, payload: SubscribePayload, args: ExecutionArgs) => Promise<GraphQLExecutionContextValue> | GraphQLExecutionContextValue);
/**
* The GraphQL root fields or resolvers to go
* alongside the schema. Learn more about them
* here: https://graphql.org/learn/execution/#root-fields-resolvers.
*
* If you return from `onSubscribe`, and the returned value is
* missing the `rootValue` field, the relevant operation root
* will be used instead.
*/
roots?: undefined | {
[operation in OperationTypeNode]?: Record<string, NonNullable<ExecutionArgs["rootValue"]>>;
};
/**
* A custom GraphQL parse function allowing you to apply your own
* parsing logic.
*
* Will not be used when implementing a custom `onSubscribe`.
*
* Throwing an error from within this function will close the socket
* with the `Error` message in the close event reason.
*/
parse?: undefined | typeof parse;
/**
* A custom GraphQL validate function allowing you to apply your
* own validation rules.
*
* Returned, non-empty, array of `GraphQLError`s will be communicated
* to the client through the `ErrorMessage`. Use an empty array if the
* document is valid and no errors have been encountered.
*
* Will not be used when implementing a custom `onSubscribe`.
*
* Throwing an error from within this function will close the socket
* with the `Error` message in the close event reason.
*/
validate?: undefined | typeof validate;
/**
* Is the `execute` function from GraphQL which is
* used to execute the query and mutation operations.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
execute?: undefined | ((args: ExecutionArgs) => OperationResult);
/**
* Is the `subscribe` function from GraphQL which is
* used to execute the subscription operation.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
subscribe?: undefined | ((args: ExecutionArgs) => OperationResult);
/**
* The amount of time for which the server will wait
* for `ConnectionInit` message.
*
* Set the value to `Infinity`, `''`, `0`, `null` or `undefined` to skip waiting.
*
* If the wait timeout has passed and the client
* has not sent the `ConnectionInit` message,
* the server will terminate the socket by
* dispatching a close event `4408: Connection initialisation timeout`
*
* @default 3_000 // 3 seconds
*/
connectionInitWaitTimeout?: undefined | number;
/**
* Is the connection callback called when the
* client requests the connection initialisation
* through the message `ConnectionInit`.
*
* The message payload (`connectionParams` from the
* client) is present in the `Context.connectionParams`.
*
* - Returning `true` or nothing from the callback will
* allow the client to connect.
*
* - Returning `false` from the callback will
* terminate the socket by dispatching the
* close event `4403: Forbidden`.
*
* - Returning a `Record` from the callback will
* allow the client to connect and pass the returned
* value to the client through the optional `payload`
* field in the `ConnectionAck` message.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
onConnect?: undefined | ((ctx: Context<P, E>) => Promise<Record<string, unknown> | boolean | void> | Record<string, unknown> | boolean | void);
/**
* Called when the client disconnects for whatever reason after
* he successfully went through the connection initialisation phase.
* Provides the close event too. Beware that this callback happens
* AFTER all subscriptions have been gracefully completed and BEFORE
* the `onClose` callback.
*
* If you are interested in tracking the subscriptions completions,
* consider using the `onComplete` callback.
*
* This callback will be called EXCLUSIVELY if the client connection
* is acknowledged. Meaning, `onConnect` will be called before the `onDisconnect`.
*
* For tracking socket closures at any point in time, regardless
* of the connection state - consider using the `onClose` callback.
*/
onDisconnect?: undefined | ((ctx: Context<P, E>, code?: number, reason?: string) => Promise<void> | void);
/**
* Called when the client sends a {@link MessageType.Ping} message, at any
* point after the connection is opened - before or after the connection
* initialisation phase.
*
* If the client sent the ping with a payload, it will be passed through the
* second argument. The first argument provides the {@link Context} of the
* connection.
*
* If this callback is implemented, the server will still automatically reply
* to the ping with a pong, right after the callback resolves. Use the
* low-level `onPing` listener on the websocket itself for full control over
* the response - implementing that listener disables the automatic pong.
*/
onPing?: undefined | ((ctx: Context<P, E>, payload: PingMessage["payload"]) => Promise<void> | void);
/**
* Called when the client sends a {@link MessageType.Pong} message, at any
* point after the connection is opened - before or after the connection
* initialisation phase.
*
* If the client sent the pong with a payload, it will be passed through the
* second argument. The first argument provides the {@link Context} of the
* connection.
*/
onPong?: undefined | ((ctx: Context<P, E>, payload: PongMessage["payload"]) => Promise<void> | void);
/**
* Called when the socket closes for whatever reason, at any
* point in time. Provides the close event too. Beware
* that this callback happens AFTER all subscriptions have
* been gracefully completed and AFTER the `onDisconnect` callback.
*
* If you are interested in tracking the subscriptions completions,
* consider using the `onComplete` callback.
*
* In comparison to `onDisconnect`, this callback will ALWAYS
* be called, regardless if the user successfully went through
* the connection initialisation or not. `onConnect` might not
* called before the `onClose`.
*/
onClose?: undefined | ((ctx: Context<P, E>, code?: number, reason?: string) => Promise<void> | void);
/**
* The subscribe callback executed right after
* acknowledging the request before any payload
* processing has been performed.
*
* If you return `ExecutionArgs` from the callback,
* it will be used instead of trying to build one
* internally. In this case, you are responsible
* for providing a ready set of arguments which will
* be directly plugged in the operation execution.
*
* Omitting the fields `contextValue` or `rootValue`
* from the returned value will have the provided server
* options fill in the gaps.
*
* To report GraphQL errors simply return an array
* of them from the callback, they will be reported
* to the client through the error message.
*
* Useful for preparing the execution arguments
* following a custom logic. A typical use case are
* persisted queries, you can identify the query from
* the subscribe message and create the GraphQL operation
* execution args which are then returned by the function.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
onSubscribe?: undefined | ((ctx: Context<P, E>, id: string, payload: SubscribePayload) => Promise<ExecutionArgs | readonly GraphQLError[] | void> | ExecutionArgs | readonly GraphQLError[] | void);
/**
* Executed after the operation call resolves. For streaming
* operations, triggering this callback does not necessarily
* mean that there is already a result available - it means
* that the subscription process for the stream has resolved
* and that the client is now subscribed.
*
* The `OperationResult` argument is the result of operation
* execution. It can be an iterator or already a value.
*
* If you want the single result and the events from a streaming
* operation, use the `onNext` callback.
*
* Use this callback to listen for subscribe operation and
* execution result manipulation.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
onOperation?: undefined | ((ctx: Context<P, E>, id: string, payload: SubscribePayload, args: ExecutionArgs, result: OperationResult) => Promise<OperationResult | void> | OperationResult | void);
/**
* Executed after an error occurred right before it
* has been dispatched to the client.
*
* Use this callback to format the outgoing GraphQL
* errors before they reach the client.
*
* Returned result will be injected in the error message payload.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
onError?: undefined | ((ctx: Context<P, E>, id: string, payload: SubscribePayload, errors: readonly GraphQLError[]) => Promise<readonly GraphQLFormattedError[] | void> | readonly GraphQLFormattedError[] | void);
/**
* Executed after an operation has emitted a result right before
* that result has been sent to the client. Results from both
* single value and streaming operations will appear in this callback.
*
* Use this callback if you want to format the execution result
* before it reaches the client.
*
* Returned result will be injected in the next message payload.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*/
onNext?: undefined | ((ctx: Context<P, E>, id: string, payload: SubscribePayload, args: ExecutionArgs, result: ExecutionResult$1) => Promise<FormattedExecutionResult | void> | FormattedExecutionResult | void);
/**
* The complete callback is executed after the
* operation has completed right before sending
* the complete message to the client.
*
* Throwing an error from within this function will
* close the socket with the `Error` message
* in the close event reason.
*
* Since the library makes sure to complete streaming
* operations even after an abrupt closure, this callback
* will still be called.
*/
onComplete?: undefined | ((ctx: Context<P, E>, id: string, payload: SubscribePayload) => Promise<void> | void);
/**
* An optional override for the JSON.parse function used to hydrate
* incoming messages to this server. Useful for parsing custom datatypes
* out of the incoming JSON.
*/
jsonMessageReviver?: undefined | JSONMessageReviver;
/**
* An optional override for the JSON.stringify function used to serialize
* outgoing messages to from server. Useful for serializing custom
* datatypes out to the client.
*/
jsonMessageReplacer?: undefined | JSONMessageReplacer;
}
interface Server<E = undefined> {
/**
* New socket has been established. The lib will validate
* the protocol and use the socket accordingly. Returned promise
* will resolve after the socket closes.
*
* The second argument will be passed in the `extra` field
* of the `Context`. You may pass the initial request or the
* original WebSocket, if you need it down the road.
*
* Returns a function that should be called when the same socket
* has been closed, for whatever reason. The close code and reason
* must be passed for reporting to the `onDisconnect` callback. Returned
* promise will resolve once the internal cleanup is complete.
*/
opened(socket: WebSocket$1, ctxExtra: E): (code?: number, reason?: string) => Promise<void>;
}
interface WebSocket$1 {
/**
* The subprotocol of the WebSocket. Will be used
* to validate against the supported ones.
*/
readonly protocol: string;
/**
* Sends a message through the socket. Will always
* provide a `string` message.
*
* Please take care that the send is ready. Meaning,
* only provide a truly OPEN socket through the `opened`
* method of the `Server`.
*
* The returned promise is used to control the flow of data
* (like handling backpressure).
*/
send(data: string): Promise<void> | void;
/**
* Closes the socket gracefully. Will always provide
* the appropriate code and close reason. `onDisconnect`
* callback will be called.
*
* The returned promise is used to control the graceful
* closure.
*/
close(code?: number, reason?: string): Promise<void> | void;
/**
* Called when message is received. The library requires the data
* to be a `string`.
*
* All operations requested from the client will block the promise until
* completed, this means that the callback will not resolve until all
* subscription events have been emitted (or until the client has completed
* the stream), or until the query/mutation resolves.
*
* Exceptions raised during any phase of operation processing will
* reject the callback's promise, catch them and communicate them
* to your clients however you wish.
*/
onMessage(cb: (data: string) => Promise<void>): void;
/**
* Implement a listener for the `PingMessage` sent from the client to the server.
* If the client sent the ping with a payload, it will be passed through the
* first argument.
*
* If this listener is implemented, the server will NOT automatically reply
* to any pings from the client. Implementing it makes it your responsibility
* to decide how and when to respond.
*/
onPing?(payload: PingMessage["payload"]): Promise<void> | void;
/**
* Implement a listener for the `PongMessage` sent from the client to the server.
* If the client sent the pong with a payload, it will be passed through the
* first argument.
*/
onPong?(payload: PongMessage["payload"]): Promise<void> | void;
}
interface Context<P extends ConnectionInitMessage["payload"] = ConnectionInitMessage["payload"], E = unknown> {
/**
* Indicates that the `ConnectionInit` message
* has been received by the server. If this is
* `true`, the client wont be kicked off after
* the wait timeout has passed.
*/
readonly connectionInitReceived: boolean;
/**
* Indicates that the connection was acknowledged
* by having dispatched the `ConnectionAck` message
* to the related client.
*/
readonly acknowledged: boolean;
/** The parameters passed during the connection initialisation. */
readonly connectionParams?: Readonly<P>;
/**
* Holds the active subscriptions for this context. **All operations**
* that are taking place are aggregated here. The user is _subscribed_
* to an operation when waiting for result(s).
*
* If the subscription behind an ID is an `AsyncIterator` - the operation
* is streaming; on the contrary, if the subscription is `null` - it is simply
* a reservation, meaning - the operation resolves to a single result or is still
* pending/being prepared.
*/
readonly subscriptions: Record<ID, AsyncGenerator<unknown> | AsyncIterable<unknown> | null>;
/**
* An extra field where you can store your own context values
* to pass between callbacks.
*/
extra: E;
}
/**
* Makes a Protocol compliant WebSocket GraphQL server. The server
* is actually an API which is to be used with your favourite WebSocket
* server library!
*
* Read more about the [GraphQL over WebSocket Protocol](https://github.com/graphql/graphql-over-http/blob/main/rfcs/GraphQLOverWebSocket.md).
*
* @category Server
*/
export declare function makeServer<P extends ConnectionInitMessage["payload"] = ConnectionInitMessage["payload"], E = unknown>(options: ServerOptions<P, E>): Server<E>;
declare namespace Kind {
export { ARGUMENT, ARGUMENT_COORDINATE, BOOLEAN, DIRECTIVE, DIRECTIVE_ARGUMENT_COORDINATE, DIRECTIVE_COORDINATE, DIRECTIVE_DEFINITION, DIRECTIVE_EXTENSION, DOCUMENT, ENUM, ENUM_TYPE_DEFINITION, ENUM_TYPE_EXTENSION, ENUM_VALUE_DEFINITION, FIELD, FIELD_DEFINITION, FLOAT, FRAGMENT_ARGUMENT, FRAGMENT_DEFINITION, FRAGMENT_SPREAD, INLINE_FRAGMENT, INPUT_OBJECT_TYPE_DEFINITION, INPUT_OBJECT_TYPE_EXTENSION, INPUT_VALUE_DEFINITION, INT, INTERFACE_TYPE_DEFINITION, INTERFACE_TYPE_EXTENSION, LIST, LIST_TYPE, MEMBER_COORDINATE, NAME, NAMED_TYPE, NON_NULL_TYPE, NULL, OBJECT, OBJECT_FIELD, OBJECT_TYPE_DEFINITION, OBJECT_TYPE_EXTENSION, OPERATION_DEFINITION, OPERATION_TYPE_DEFINITION, SCALAR_TYPE_DEFINITION, SCALAR_TYPE_EXTENSION, SCHEMA_DEFINITION, SCHEMA_EXTENSION, SELECTION_SET, STRING, TYPE_COORDINATE, UNION_TYPE_DEFINITION, UNION_TYPE_EXTENSION, VARIABLE, VARIABLE_DEFINITION };
}
export {
Location$1 as Location,
Path as ResponsePath,
pathToArray as responsePathAsArray,
};
export {};
|