Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 72x 1x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 1x 1x 1x 1x 1x 19x 19x 19x 19x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 260x 260x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 72x 72x 72x 58x 58x 42x 42x 26x 26x 26x 26x 26x 26x 10x 10x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 1x 1x 1x 1x 1x 1x 10x 10x 1x 1x 1x 1x 1x 10x 10x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 5x 5x 5x 5x 72x 5x 5x 72x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 72x 72x 1x 1x 144x 144x 144x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 5x 5x 5x 5x 5x 72x 72x 72x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 1x 1x 1x 1x 1x 10x 10x 1x 1x 1x 1x 1x 15x 15x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 1x 1x 1x 1x 1x 1x 1x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 108x 108x 5x 5x 5x 108x 108x 108x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 36x 36x 36x 36x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 72x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 1x | import * as format from '../common/format';
import { getParameterNames } from './get-parameter-names';
import { Sealed } from './sealed';
import { RtType, RtObjectType, RtObjectMember } from '../common/format';
const NotProvided = Symbol();
/**
* Obtain an object which uniquely identifies an interface type.
* You may prefer reflect<InterfaceType>() if you are writing reflect(reify<InterfaceType>()) or
* ReflectedClass.from(reify<InterfaceType>())
*/
export function reify<InterfaceType>(callSite?: CallSite): format.InterfaceToken {
if (!isCallSite(callSite))
throw new Error(`reify<T>() can only be used when project is built with the typescript-rtti transformer`);
let param = reflect(callSite).typeParameters[0];
if (param.is('interface'))
return param.token;
throw new Error(`reify<${param}>(): Type parameter must be an interface reference, not an arbitrary type`);
}
export function isCallSite(callSite: CallSite) {
return callSite?.TΦ === 'c';
}
function Flag(value: string) {
return (target, propertyKey) => {
if (!target.flagToProperty)
target.flagToProperty = {};
if (!target.propertyToFlag)
target.propertyToFlag = {};
target.flagToProperty[value] = propertyKey;
target.propertyToFlag[propertyKey] = value;
};
}
export type ReflectedTypeRefKind = 'union' | 'intersection' | 'any'
| 'unknown' | 'tuple' | 'array' | 'class' | 'any' | 'unknown' | 'generic' | 'mapped' | 'literal'
| 'void' | 'interface' | 'null' | 'undefined' | 'true' | 'false' | 'object' | 'enum' | 'function';
export const TYPE_REF_KIND_EXPANSION: Record<string, ReflectedTypeRefKind> = {
[format.T_UNKNOWN]: 'unknown',
[format.T_ANY]: 'any',
[format.T_UNION]: 'union',
[format.T_INTERSECTION]: 'intersection',
[format.T_TUPLE]: 'tuple',
[format.T_ARRAY]: 'array',
[format.T_GENERIC]: 'generic',
[format.T_VOID]: 'void',
[format.T_NULL]: 'null',
[format.T_UNDEFINED]: 'undefined',
[format.T_MAPPED]: 'mapped',
[format.T_ENUM]: 'enum',
[format.T_FALSE]: 'false',
[format.T_TRUE]: 'true',
[format.T_OBJECT]: 'object',
[format.T_FUNCTION]: 'function'
};
export interface MatchesValueOptions {
/**
* An array where errors encountered while validating an object are saved.
* If you don't supply this, you won't be able to get the list of errors.
*/
errors?: Error[];
context?: string;
/**
* Whether to allow extra properties that do not conform to the type.
* Though Typescript normally allows extra properties, it is a potential
* security vulnerability if the user chooses to use this to validate
* user-controlled objects, so you have to opt in if you expect extra
* properties to be present.
*
* @default false
*/
allowExtraProperties?: boolean;
}
export class ReflectedTypeRef<T extends RtType = RtType> {
/** @internal */
constructor(
private _ref: T
) {
}
toString() {
return `[${this.kind} type]`;
}
/** @internal */
static Kind(kind: ReflectedTypeRefKind) {
return (target) => {
ReflectedTypeRef.kinds[kind] = target;
};
}
/**
* Check if the given value matches this type reference. Collects any errors into the `errors` list.
* @param value
* @param errors
* @param context
* @returns
*/
matchesValue(value, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
options.errors.push(new Error(`No validation available for type with kind '${this.kind}'`));
return false;
}
/**
* Check if the given type reference is equivalent to this type reference.
* @param ref
* @returns
*/
equals(ref : this) {
if (this === ref)
return true;
if (ref.constructor !== this.constructor)
return false;
return this.matches(ref);
}
protected matches(ref : this) {
return true;
}
private static kinds: Record<ReflectedTypeRefKind, Constructor<ReflectedTypeRef>> = <any>{};
get kind(): ReflectedTypeRefKind {
let ref = this._ref;
if (ref === null || ['string', 'number', 'bigint'].includes(typeof ref))
return 'literal';
if (typeof ref === 'object' && 'TΦ' in ref)
return TYPE_REF_KIND_EXPANSION[(<format.RtBrandedType>ref).TΦ];
if (typeof ref === 'object')
return 'interface';
return 'class';
}
/** @internal */
get ref(): Readonly<T> {
return this._ref;
}
/**
* Checks if this type reference is a Promise, optionally a Promise of a specific type.
* If the type reference does not specify a type of Promise but you have provided a type
* to check for, this will return false.
* @param klass The type of promise to check for. Would be String when looking for Promise<string>
*/
isPromise<T = Function>(klass?: Constructor<T>): this is ReflectedGenericRef {
if (this.isClass(Promise))
return !klass;
if (this.isGeneric(Promise)) {
if (klass)
return this.typeParameters.length > 0 && this.typeParameters[0].isClass(klass);
return true;
}
return false;
}
/**
* Checks if this type reference is a class. Note: If the class reference has type parameters,
* (ie it is generic) this check will fail, and instead isGeneric() will succeed.
* @param klass
*/
isClass<T = Function>(klass?: Constructor<T> | BigIntConstructor): this is ReflectedClassRef<T> {
let literalTypes = {
'string': String,
'number': Number,
'boolean': Boolean,
'object': Object,
'bigint': BigInt
};
// Support for isClass(Function) even though we now have a dedicated 'function' reflected type
if (this.kind === 'function' && klass === <any>Function)
return true;
if (this.kind === 'literal')
return literalTypes[typeof this.ref] === klass;
if (this.kind === 'null')
return <Constructor<Object>>Object === klass;
if (['true', 'false'].includes(this.kind))
return <Constructor<Object>>Boolean === klass;
return this.kind === 'class' && (!klass || <any>this.ref === klass);
}
isInterface(interfaceType?: format.InterfaceToken): this is ReflectedInterfaceRef {
if (interfaceType)
return this.isInterface() && (this.ref as unknown as format.InterfaceToken).identity === interfaceType.identity;
else
return this.kind === 'interface';
}
/**
* Checks if this type is a literal type (null/true/false or a string/number literal).
* Caution: You cannot use this to check for `undefined`. Use `isUndefined()` instead.
* @param value
* @returns
*/
isLiteral(value: null): this is ReflectedNullRef;
isLiteral(value: undefined): this is ReflectedUndefinedRef;
isLiteral(value: true): this is ReflectedTrueRef;
isLiteral(value: false): this is ReflectedFalseRef;
isLiteral<T extends format.Literal>(value: T): this is ReflectedLiteralRef<T>;
isLiteral(): this is ReflectedLiteralRef<any>;
isLiteral(value: number | bigint | string): boolean;
isLiteral(value: true | false | null | number | bigint | string | symbol = NotProvided): boolean {
if (value === null) return this.isNull();
if (value === true) return this.isTrue();
if (value === false) return this.isFalse();
return this.kind === 'literal' && (value === NotProvided || <unknown>this.ref === value);
}
/** Check if this type reference is an interface type */ is(kind: 'interface'): this is ReflectedInterfaceRef;
/** Check if this type reference is a class type */ is(kind: 'class'): this is ReflectedClassRef<any>;
/** Check if this type reference is a generic type */ is(kind: 'generic'): this is ReflectedGenericRef;
/** Check if this type reference is an array type */ is(kind: 'array'): this is ReflectedArrayRef;
/** Check if this type reference is an intersection type */ is(kind: 'intersection'): this is ReflectedIntersectionRef;
/** Check if this type reference is a union type */ is(kind: 'union'): this is ReflectedUnionRef;
/** Check if this type reference is an enum type */ is(kind: 'enum'): this is ReflectedEnumRef;
/** Check if this type reference is a tuple type */ is(kind: 'tuple'): this is ReflectedTupleRef;
/** Check if this type reference is a void type */ is(kind: 'void'): this is ReflectedVoidRef;
/** Check if this type reference is an any type */ is(kind: 'any'): this is ReflectedAnyRef;
/** Check if this type reference is an unknown type */ is(kind: 'unknown'): this is ReflectedUnknownRef;
/** Check if this type reference is a literal type */ is(kind: 'literal'): this is ReflectedLiteralRef<any>;
/**
* Check if this type reference is an instance of the given ReflectedTypeRef subclass.
* @param type The subclass of ReflectedTypeRef to check
*/
is<T, U extends T>(this: T, type: Constructor<U>): this is U;
is(this, kind: ReflectedTypeRefKind | Constructor<any>): boolean {
if (typeof kind === 'function')
return this instanceof kind;
else if (typeof kind === 'string')
return this.kind === kind;
}
/**
* Assert that this type reference is an interface type and cast it to ReflectedInterfaceRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'interface'): ReflectedInterfaceRef;
/**
* Assert that this type reference is a Function type and cast it to ReflectedFunctionRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'function'): ReflectedFunctionRef;
/**
* Assert that this type reference is a class type and cast it to ReflectedClassRef.
* If the reference is not the correct type an error is thrown.
*/
as<T = any>(kind: 'class'): ReflectedClassRef<T>;
/**
* Assert that this type reference is a generic type and cast it to ReflectedGenericRef.
* If the reference is not the correct type an error is thrown.
*/
as<T = any>(kind: 'generic'): ReflectedGenericRef;
/**
* Assert that this type reference is an enum type and cast it to ReflectedEnumRef.
* If the reference is not the correct type an error is thrown.
*/
as<T = any>(kind: 'enum'): ReflectedEnumRef;
/**
* Assert that this type reference is an array type and cast it to ReflectedArrayRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'array'): ReflectedArrayRef;
/**
* Assert that this type reference is an intersection type and cast it to ReflectedIntersectionRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'intersection'): ReflectedIntersectionRef;
/**
* Assert that this type reference is a union type and cast it to ReflectedUnionRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'union'): ReflectedUnionRef;
/**
* Assert that this type reference is a tuple type and cast it to ReflectedTupleRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'tuple'): ReflectedTupleRef;
/**
* Assert that this type reference is a void type and cast it to ReflectedVoidRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'void'): ReflectedVoidRef;
/**
* Assert that this type reference is a void type and cast it to ReflectedVoidRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'unknown'): ReflectedUnknownRef;
/**
* Assert that this type reference is a void type and cast it to ReflectedVoidRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'any'): ReflectedAnyRef;
/**
* Assert that this type reference is a void type and cast it to ReflectedVoidRef.
* If the reference is not the correct type an error is thrown.
*/
as(kind: 'literal'): ReflectedLiteralRef;
/**
* Assert that this type reference is the given ReflectedTypeRef subclass.
* If the reference is not the correct type an error is thrown.
*/
as<T, U extends T>(this: T, subclass: Constructor<U>): U;
as(this, subclass: ReflectedTypeRefKind | Constructor<any>) {
if (typeof subclass === 'function' && !(this instanceof subclass))
throw new TypeError(`Value of type ${this.constructor.name} cannot be converted to ${subclass.name}`);
else if (typeof subclass === 'string' && this.kind !== subclass)
throw new TypeError(`Type has kind ${this.kind}, expected ${subclass}`);
return this;
}
isVoid(): this is ReflectedVoidRef { return this.kind === 'void'; }
isNull(): this is ReflectedNullRef { return this.kind === 'null'; }
isUndefined(): this is ReflectedUndefinedRef { return this.kind === 'undefined'; }
isTrue(): this is ReflectedTrueRef { return this.kind === 'true'; }
isFalse(): this is ReflectedFalseRef { return this.kind === 'false'; }
isStringLiteral(): this is ReflectedLiteralRef<string> { return this.kind === 'literal' && typeof this.ref === 'string'; }
isNumberLiteral(): this is ReflectedLiteralRef<number> { return this.kind === 'literal' && typeof this.ref === 'number'; }
isBigIntLiteral(): this is ReflectedLiteralRef<bigint> { return this.kind === 'literal' && typeof this.ref === 'bigint'; }
isBooleanLiteral(): this is ReflectedLiteralRef<number> { return this.isTrue() || this.isFalse(); }
/**
* Check if this type reference is a generic type, optionally checking if the generic's
* base type is the given class. For instance isGeneric(Promise) is true for Promise<string>.
* @param klass
*/
isGeneric<T = Function>(klass?: Constructor<T>): this is ReflectedGenericRef {
if (this.kind === 'generic') {
let rtGeneric: format.RtGenericType = <any>this.ref;
if (!rtGeneric.t['TΦ']) { // this is a class
return !klass || rtGeneric.t === klass;
}
return true;
}
return false;
}
isUnion(elementDiscriminator?: (elementType: ReflectedTypeRef) => boolean): this is ReflectedUnionRef {
return elementDiscriminator
? this.isUnion() && this.types.every(e => elementDiscriminator(e))
: this.kind === 'union';
}
isIntersection(elementDiscriminator?: (elementType: ReflectedTypeRef) => boolean): this is ReflectedIntersectionRef {
return elementDiscriminator
? this.isIntersection() && this.types.every(e => elementDiscriminator(e))
: this.kind === 'intersection';
}
isArray(elementDiscriminator?: (elementType: ReflectedTypeRef) => boolean): this is ReflectedArrayRef {
return elementDiscriminator
? this.isArray() && elementDiscriminator(this.elementType)
: this.kind === 'array'
;
}
isTuple(elementDiscriminators?: ((elementType: ReflectedTupleElement) => boolean)[]): this is ReflectedTupleRef {
return elementDiscriminators
? this.isTuple() && this.elements.every((e, i) => elementDiscriminators[i](e))
: this.kind === 'tuple';
}
isUnknown() {
return this.kind === 'unknown';
}
isAny() {
return this.kind === 'any';
}
/**
* Creates an "unknown"
* @internal
*/
static createUnknown() {
return this.createFromRtRef({ TΦ: format.T_UNKNOWN });
}
/** @internal */
static createFromRtRef(ref: format.RtType) {
let kind: ReflectedTypeRefKind;
if (ref === null || !['object', 'function'].includes(typeof ref))
kind = 'literal';
else if (typeof ref === 'object' && 'TΦ' in <object>ref)
kind = TYPE_REF_KIND_EXPANSION[(ref as format.RtBrandedType).TΦ];
else if (typeof ref === 'object')
kind = 'interface';
else
kind = 'class';
return new (ReflectedTypeRef.kinds[kind] || ReflectedTypeRef)(ref);
}
}
@ReflectedTypeRef.Kind('class')
export class ReflectedClassRef<Class> extends ReflectedTypeRef<Constructor<Class>> {
get kind() { return 'class' as const; }
get class(): Constructor<Class> { return <any>this.ref; }
get reflectedClass() { return ReflectedClass.for(this.class); }
toString() { return `class ${this.class.name}`; }
protected override matches(ref : this) {
return this.class === ref.class;
}
override matchesValue(value: any, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
if (this.ref === String)
return typeof value === 'string';
else if (this.ref === Number)
return typeof value === 'number';
else if (this.ref === Boolean)
return typeof value === 'boolean';
else if (this.ref === Object)
return typeof value === 'object';
else if (this.ref === Function)
return typeof value === 'function';
else if (this.ref === Symbol)
return typeof value === 'symbol'
else if (this.ref === BigInt)
return typeof value === 'bigint';
return ReflectedClass.for(this.ref).matchesValue(value, options);
}
}
export class ReflectedObjectMember {
constructor(private ref: RtObjectMember) {
this.name = ref.n;
this.type = ReflectedTypeRef.createFromRtRef(this.ref.t);
}
readonly name: string;
readonly type: ReflectedTypeRef;
private _flags: ReflectedFlags;
get flags() {
if (!this._flags)
this._flags = new ReflectedFlags(this.ref.f);
return this._flags;
}
get isOptional() { return this.flags.isOptional; }
equals(member: this) {
return this.name === member.name && this.type.equals(member.type);
}
toString() { return `${this.name}: ${this.type?.toString() ?? '<error>'}`; }
}
@ReflectedTypeRef.Kind('object')
export class ReflectedObjectRef extends ReflectedTypeRef<RtObjectType> {
get kind() { return 'object' as const; }
private _members: ReflectedObjectMember[];
get members(): Readonly<ReflectedObjectMember[]> {
if (!this._members)
this._members = this.ref.m.map(m => new ReflectedObjectMember(m));
return this._members;
}
toString() { return `{ ${this.members.map(m => m.toString()).join(', ')} }`; }
protected override matches(ref : this) {
if (this.members.length !== ref.members.length)
return false;
for (let member of this.members) {
let matchingMember = ref.members.find(x => x.name);
if (!member.equals(matchingMember))
return false;
}
return true;
}
override matchesValue(value: any, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
if (typeof value !== 'object')
return false;
let matches = true;
for (let member of this.members) {
let hasValue = member.name in value;
if (!hasValue) {
if (!member.isOptional) {
options.errors.push(new TypeError(`Missing value for member ${member.toString()}`));
matches = false;
}
continue;
}
let memberValue = value[member.name];
let memberErrors = [];
if (!member.type.matchesValue(memberValue, { ...options, errors: memberErrors })) {
options.errors.push(new TypeError(`Value for member ${member.toString()} is invalid`));
options.errors.push(...memberErrors);
matches = false;
}
}
let unaccountedProperties = Object.keys(value).filter(x => !this.members.some(y => y.name === x));
if (options.allowExtraProperties !== true && unaccountedProperties.length > 0) {
options.errors.push(
new Error(
`Object contains the following undeclared properties: `
+ `${unaccountedProperties.join(', ')}`
)
);
matches = false;
}
return matches;
}
}
@ReflectedTypeRef.Kind('interface')
export class ReflectedInterfaceRef extends ReflectedTypeRef<format.InterfaceToken> {
get kind() { return 'interface' as const; }
get token(): format.InterfaceToken { return this.ref; }
get reflectedInterface() { return ReflectedClass.for(this.token); }
toString() { return `interface ${this.token.name}`; }
protected override matches(ref : this) {
return this.token === ref.token;
}
override matchesValue(value: any, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
return ReflectedClass.for(this.ref).matchesValue(value);
}
}
@ReflectedTypeRef.Kind('literal')
export class ReflectedLiteralRef<Class extends format.Literal = format.Literal> extends ReflectedTypeRef<Class> {
get kind() { return 'literal' as const; }
get value() { return <Class>this.ref; }
toString() { return JSON.stringify(this.value); }
protected override matches(ref : this) {
return this.value === ref.value;
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return this.ref === value;
}
}
@ReflectedTypeRef.Kind('union')
export class ReflectedUnionRef extends ReflectedTypeRef<format.RtUnionType> {
get kind() { return 'union' as const; }
toString() { return `[${this.types.join(' | ')}]`; }
private _types: ReflectedTypeRef[];
get types(): ReflectedTypeRef[] {
if (this._types)
return this._types;
return this._types = (this.ref.t || []).map(t => ReflectedTypeRef.createFromRtRef(t));
}
protected override matches(ref : this) {
if (this.types.length !== ref.types.length)
return false;
for (let type of this.types) {
if (!ref.types.some(x => type.equals(x)))
return false;
}
return true;
}
override matchesValue(value: any, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
return this.types.some(t => t.matchesValue(value, options));
}
}
@ReflectedTypeRef.Kind('intersection')
export class ReflectedIntersectionRef extends ReflectedTypeRef<format.RtIntersectionType> {
get kind() { return 'intersection' as const; }
toString() { return `${this.types.join(' & ')}`; }
private _types: ReflectedTypeRef[];
get types() {
if (this._types)
return this._types;
return this._types = (this.ref.t || []).map(t => ReflectedTypeRef.createFromRtRef(t));
}
protected override matches(ref : this) {
if (this.types.length !== ref.types.length)
return false;
for (let type of this.types) {
if (!ref.types.some(x => type.equals(x)))
return false;
}
return true;
}
override matchesValue(value: any, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
return this.types.every(t => t.matchesValue(value, options));
}
}
@ReflectedTypeRef.Kind('array')
export class ReflectedArrayRef extends ReflectedTypeRef<format.RtArrayType> {
get kind() { return 'array' as const; }
toString() { return `${this.elementType}[]`; }
private _elementType: ReflectedTypeRef;
get elementType(): ReflectedTypeRef {
if (this._elementType)
return this._elementType;
return this._elementType = ReflectedTypeRef.createFromRtRef(this.ref.e);
}
protected override matches(ref : this) {
return this.elementType.equals(ref.elementType);
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
if (!Array.isArray(value)) {
options.errors.push(new TypeError(`Value should be an array`));
return false;
}
return (value as any[]).every(value => this.elementType.matchesValue(value, options));
}
}
@ReflectedTypeRef.Kind('void')
export class ReflectedVoidRef extends ReflectedTypeRef<format.RtVoidType> {
get kind() { return 'void' as const; }
toString() { return `void`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
if (value !== void 0) {
options.errors.push(new Error(`Value must not be present`));
return false;
}
return true;
}
}
@ReflectedTypeRef.Kind('null')
export class ReflectedNullRef extends ReflectedTypeRef<format.RtNullType> {
get kind() { return 'null' as const; }
toString() { return `null`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return value === null;
}
}
@ReflectedTypeRef.Kind('undefined')
export class ReflectedUndefinedRef extends ReflectedTypeRef<format.RtUndefinedType> {
get kind() { return 'undefined' as const; }
toString() { return `undefined`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return value === undefined;
}
}
@ReflectedTypeRef.Kind('false')
export class ReflectedFalseRef extends ReflectedTypeRef<format.RtFalseType> {
get kind() { return 'false' as const; }
toString() { return `false`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return value === false;
}
}
@ReflectedTypeRef.Kind('true')
export class ReflectedTrueRef extends ReflectedTypeRef<format.RtTrueType> {
get kind() { return 'true' as const; }
toString() { return `true`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return value === true;
}
}
@ReflectedTypeRef.Kind('unknown')
export class ReflectedUnknownRef extends ReflectedTypeRef<format.RtUnknownType> {
get kind() { return 'unknown' as const; }
toString() { return `unknown`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return true;
}
}
@ReflectedTypeRef.Kind('any')
export class ReflectedAnyRef extends ReflectedTypeRef<format.RtAnyType> {
get kind() { return 'any' as const; }
toString() { return `any`; }
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return true;
}
}
@ReflectedTypeRef.Kind('tuple')
export class ReflectedTupleRef extends ReflectedTypeRef<format.RtTupleType> {
get kind() { return 'tuple' as const; }
toString() { return `[${this.elements.join(', ')}]`; }
private _elements: ReflectedTupleElement[];
get elements(): ReflectedTupleElement[] {
if (this._elements)
return this._elements;
return this._elements = (this.ref.e || []).map(e => new ReflectedTupleElement(e));
}
protected override matches(ref : this) {
if (this.elements.length !== ref.elements.length)
return false;
return this.elements.every((x, i) => x.name === ref.elements[i].name && x.type.equals(ref.elements[i].type));
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
if (!Array.isArray(value)) {
options.errors.push(new Error(`Value must be an array`));
return false;
}
let array = <any[]>value;
if (array.length !== this.elements.length) {
options.errors.push(new Error(`Array must have ${this.elements.length} values to match tuple type`));
return false;
}
return this.elements.every((v, i) => v.type.matchesValue(array[i], options));
}
}
@ReflectedTypeRef.Kind('generic')
export class ReflectedGenericRef extends ReflectedTypeRef<format.RtGenericType> {
get kind() { return 'generic' as const; }
toString() { return `${this.baseType}<${this.typeParameters.join(', ')}>`; }
private _baseType: ReflectedTypeRef;
get baseType(): ReflectedTypeRef {
if (this._baseType)
return this._baseType;
return this._baseType = ReflectedTypeRef.createFromRtRef(this.ref.t);
}
private _typeParameters: ReflectedTypeRef[];
get typeParameters(): ReflectedTypeRef[] {
if (this._typeParameters)
return this._typeParameters;
return this._typeParameters = this.ref.p.map(p => ReflectedTypeRef.createFromRtRef(p));
}
protected override matches(ref : this) {
if (this.typeParameters.length !== ref.typeParameters.length)
return false;
return this.typeParameters.every((x, i) => x.equals(ref.typeParameters[i]));
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return this.baseType.matchesValue(value, options);
}
}
@ReflectedTypeRef.Kind('enum')
export class ReflectedEnumRef extends ReflectedTypeRef<format.RtEnumType> {
get kind() { return 'enum' as const; }
toString() { return `enum`; } // TODO: name of enum?
private _enum: any;
get enum() {
if (!this._enum)
this._enum = this.ref.e;
return this._enum;
}
private _name: string;
get name() {
if (!this._name)
this._name = this.ref.n;
return this._name;
}
private _values: EnumValue[];
get values() {
if (!this._values) {
this._values = Object.keys(this.enum)
.filter(x => !/^\d+$/.test(x))
.map(name => ({ name, value: this.enum[name] }))
;
}
return this._values;
}
protected override matches(ref : this) {
return this.enum === ref.enum;
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return value in this.enum;
}
}
@ReflectedTypeRef.Kind('function')
export class ReflectedFunctionRef extends ReflectedTypeRef<format.RtFunctionType> {
get kind() { return 'function' as const; }
toString() { return `function`; } // TODO: details
private _returnType: ReflectedTypeRef;
get returnType() {
return this._returnType ??= ReflectedTypeRef.createFromRtRef(this.ref.r);
}
private _parameters: ReflectedParameter[];
get parameters() {
return this._parameters ??= (this.ref.p ?? []).map((p, i) => new ReflectedParameter(p, i));
}
private _flags: ReflectedFlags;
/**
* No use for this yet, reserved for future use
* @internal
*/
get flags() {
return this._flags ??= new ReflectedFlags(this.ref.f);
}
protected override matches(ref : this | ReflectedFunction) {
return this.returnType.equals(ref.returnType)
&& this.parameters.every((p, i) => p.equals(ref.parameters[i]))
&& this.flags.toString() === ref.flags.toString()
;
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
return this.matches(ReflectedFunction.for(value));
}
}
export interface EnumValue {
name: string;
value: number;
}
@ReflectedTypeRef.Kind('mapped')
export class ReflectedMappedRef extends ReflectedTypeRef<format.RtMappedType> {
get kind() { return 'mapped' as const; }
toString() { return `${this.baseType}<${this.typeParameters.join(', ')}>`; }
private _baseType: ReflectedTypeRef;
get baseType(): ReflectedTypeRef {
if (this._baseType)
return this._baseType;
return this._baseType = ReflectedTypeRef.createFromRtRef(this.ref.t);
}
private _typeParameters: ReflectedTypeRef[];
get typeParameters(): ReflectedTypeRef[] {
if (this._typeParameters)
return this._typeParameters;
return this._typeParameters = this.ref.p.map(p => ReflectedTypeRef.createFromRtRef(p));
}
private _members: ReflectedObjectMember[];
get members(): Readonly<ReflectedObjectMember[]> {
if (!this._members)
this._members = this.ref.m.map(m => new ReflectedObjectMember(m));
return this._members;
}
protected override matches(ref : this) {
if (this.typeParameters.length !== ref.typeParameters.length)
return false;
return this.typeParameters.every((x, i) => x.equals(ref.typeParameters[i]));
}
override matchesValue(value: any, options?: MatchesValueOptions): boolean {
options ??= {};
options.errors ??= [];
if (!this.ref.m)
return this.baseType.matchesValue(value, options);
if (typeof value !== 'object')
return false;
let matches = true;
for (let member of this.members) {
let hasValue = member.name in value;
if (!hasValue) {
if (!member.isOptional) {
options.errors.push(new TypeError(`Missing value for member ${member.toString()}`));
matches = false;
}
continue;
}
let memberValue = value[member.name];
let memberErrors = [];
if (!member.type.matchesValue(memberValue, { ...options, errors: memberErrors })) {
options.errors.push(new TypeError(`Value for member ${member.toString()} is invalid`));
options.errors.push(...memberErrors);
matches = false;
}
}
return matches;
}
}
export class ReflectedTupleElement {
constructor(readonly ref: Readonly<format.RtTupleElement>) {
}
toString() {
return `${this.name} : ${this.type}`;
}
get name(): string {
return this.ref.n;
}
private _type: ReflectedTypeRef;
get type(): ReflectedTypeRef {
if (this._type)
return this._type;
return this._type = ReflectedTypeRef.createFromRtRef(this.ref.t);
}
}
export class ReflectedFlags {
constructor(flags: string) {
if (!flags)
flags = '';
Object.keys(this.flagToProperty)
.forEach(flag => this[this.flagToProperty[flag]] = flags.includes(flag));
}
private flagToProperty: Record<string, string>;
private propertyToFlag: Record<string, string>;
@Flag(format.F_READONLY) isReadonly: boolean;
@Flag(format.F_ABSTRACT) isAbstract: boolean;
@Flag(format.F_PUBLIC) isPublic: boolean;
@Flag(format.F_PRIVATE) isPrivate: boolean;
@Flag(format.F_PROTECTED) isProtected: boolean;
@Flag(format.F_PROPERTY) isProperty: boolean;
@Flag(format.F_METHOD) isMethod: boolean;
@Flag(format.F_CLASS) isClass: boolean;
@Flag(format.F_INTERFACE) isInterface: boolean;
@Flag(format.F_OPTIONAL) isOptional: boolean;
@Flag(format.F_REST) isRest: boolean;
@Flag(format.F_ASYNC) isAsync: boolean;
@Flag(format.F_EXPORTED) isExported: boolean;
@Flag(format.F_INFERRED) isInferred: boolean;
@Flag(format.F_OMITTED) isOmitted: boolean;
@Flag(format.F_ARRAY_BINDING) isArrayBinding: boolean;
@Flag(format.F_OBJECT_BINDING) isObjectBinding: boolean;
toString() {
return Object.keys(this.propertyToFlag)
.map(property => this[property] ? this.propertyToFlag[property] : '')
.join('');
}
}
export type Visibility = 'public' | 'private' | 'protected';
/**
* Reflection data for a parameter
*/
export class ReflectedParameter<ValueT = any> {
constructor(
readonly rawMetadata: format.RtParameter,
readonly index: number
) {
}
private _flags: ReflectedFlags;
get isBinding() {
return this.isArrayBinding || this.isObjectBinding;
}
/**
* True if this parameter is an array binding expression (destructured assignment).
*/
get isArrayBinding() {
return this.flags.isArrayBinding;
}
/**
* True if this parameter is an object binding expression (destructured assignment).
*/
get isObjectBinding() {
return this.flags.isObjectBinding;
}
/**
* True if this parameter is an omitted slot within an array binding expression.
* ie, if the user declares [foo, ,bar], then the second binding will have isOmitted true.
* See: destructured assignment.
*/
get isOmitted() {
return this.flags.isOmitted;
}
private _bindings: ReflectedParameter[];
/**
* If this is an object/array binding (ie destructured assignment),
* this will return the individual bindings that are part of this declaration.
*/
get bindings() {
if (!this.isBinding)
return undefined;
if (!this._bindings) {
(this.rawMetadata.b || []).map((bindingElement, i) => new ReflectedParameter(bindingElement, i))
}
return this._bindings;
}
/**
* Get the unmangled original name for this parameter. This may be undefined if the parameter is an array/object
* binding expression (destructured assignment).
*/
get name() {
return this.rawMetadata.n;
}
private _type: ReflectedTypeRef;
/**
* Get the reflected type of this parameter
*/
get type(): ReflectedTypeRef {
if (this._type)
return this._type;
return this._type = ReflectedTypeRef.createFromRtRef(this.rawMetadata.t());
}
/**
* Get flags that define aspects of this property.
*/
get flags() {
if (this._flags)
return this._flags;
return this._flags = new ReflectedFlags(this.rawMetadata.f);
}
/**
* True if this parameter is optional
*/
get isOptional() {
return this.flags.isOptional;
}
/**
* True if this parameter is a rest parameter
*/
get isRest() {
return this.flags.isRest;
}
/**
* Retrieve the initializer for this parameter. Invoking the initializer produces the
* default value for the parameter. Caution: The initializer depends on the value of 'this'.
* Use evaluateInitializer() to properly invoke the initializer.
*/
get initializer(): () => ValueT {
return this.rawMetadata.v;
}
/**
* Evaluate the initializer for this parameter with the given value for 'this'. If not provided,
* 'this' is an empty object. This is suitable for constructor parameters but instance method parameters
* may reference properties of the object, and so getting the correct value may require passing an
* appropriate instance.
*
* @param thisObject
* @returns
*/
evaluateInitializer(thisObject: any = {}) {
return this.initializer.apply(thisObject, []);
}
/**
* Check if this parameter declaration is identical to another parameter declaration (including its name).
*
* @param other The other parameter to check against
* @param checkName If true, the name is checked, otherwise it is ignored
* @returns
*/
equals(other: ReflectedParameter, checkName = true) {
return (!checkName || this.name === other.name)
&& this.type.equals(other.type)
&& this.flags.toString() === other.flags.toString()
;
}
}
/**
* Reflection data for a method parameter
*/
export class ReflectedMethodParameter extends ReflectedParameter {
constructor(
readonly method: ReflectedMethod,
readonly rawMetadata: format.RtParameter,
readonly index: number,
) {
super(rawMetadata, index);
}
get parent() { return this.method; }
get class() { return this.method.class; }
}
/**
* Reflection data for a method parameter
*/
export class ReflectedFunctionParameter extends ReflectedParameter {
constructor(
readonly func: ReflectedFunction,
readonly rawMetadata: format.RtParameter,
readonly index: number
) {
super(rawMetadata, index);
}
get parent() { return this.func; }
}
/**
* Reflection data for a constructor parameter
*/
export class ReflectedConstructorParameter extends ReflectedParameter {
constructor(
readonly reflectedClass: ReflectedClass,
readonly rawMetadata: format.RtParameter,
readonly index: number
) {
super(rawMetadata, index);
this._class = reflectedClass;
}
private _class: ReflectedClass;
get parent() { return this.class; }
/**
* Retrieve the reflected class that this constructor parameter is defined on.
*/
get class() {
return this._class;
}
/**
* True if this constructor parameter is declared readonly, meaning it is
* also an instance property of the class.
*/
get isReadonly() {
return this.flags.isReadonly;
}
/**
* True if this constructor parameter is declared public, meaning it is
* also an instance property of the class.
*/
get isPublic() {
return this.flags.isPublic;
}
/**
* True if this constructor parameter is declared protected, meaning it is
* also an instance property of the class.
*/
get isProtected() {
return this.flags.isProtected;
}
/**
* True if this constructor parameter is declared private, meaning it is
* also an instance property of the class.
*/
get isPrivate() {
return this.flags.isPrivate;
}
/**
* Get visibility of this constructor parameter. If the constructor
* parameter has no visibility modifiers, this is null.
*/
get visibility(): Visibility {
return this.isPublic ? 'public'
: this.isProtected ? 'protected'
: this.isPrivate ? 'private'
: null;
}
/**
* True if the constructor parameter is also a property.
*/
get isProperty() {
return this.visibility !== null || this.isReadonly;
}
}
/**
* Reflection data for a class member
*/
export class ReflectedMember implements ReflectedMetadataTarget {
constructor(
reflectedClass: ReflectedClass,
readonly name: string,
readonly isStatic: boolean
) {
this._class = reflectedClass;
}
private _class: ReflectedClass;
private _flags: ReflectedFlags;
/**
* Get the given metadata key for this member. This is equivalent to
* Reflect.getMetadata(key, this.host, this.name)
* @param key
* @returns
*/
getMetadata<T = any>(key: string): T {
return Reflect.getMetadata(key, this.host, this.name);
}
/**
* Define a metadata key for this member. This is equivalent to
* Reflect.defineMetadata(key, value, this.host, this.name)
* @param key
* @returns
*/
defineMetadata<T = any>(key: string, value: T) {
Reflect.defineMetadata(key, value, this.host, this.name);
return value;
}
/**
* Get or define a metadata item for this member. If the key already exists, its
* value is returned without calling the passed function. Otherwise the passed function
* is called and its value is saved to the given metadata key.
*
* @param key The metadata key to fetch
* @param definer A function which will define the value of the metadata
* @returns The value of the existing metadata key or the new value returned by the definer function
* which will also be defined as the appropriate metadata item on this member.
*/
metadata<T = any>(key: string, definer: () => T): T {
if (this.hasMetadata(key))
return this.getMetadata(key);
let value = definer();
this.defineMetadata(key, value);
return value;
}
/**
* Check if a metadata key exists for this member. This is equivalent to
* Reflect.hasMetadata(key, this.host, this.name)
* @param key
* @returns
*/
hasMetadata(key: string): boolean {
return Reflect.hasMetadata(key, this.host, this.name);
}
/**
* Get the host object for this method. For static members this is the
* class constructor. For instance members this is the class's prototype.
*/
get host() {
return this.isStatic ? this.class.class : this.class.prototype;
}
/**
* Get the reflected class that hosts this member
*/
get class() {
return this._class;
}
/**
* Get the flags for this member. Includes modifiers and other properties about
* the member.
*/
get flags(): Readonly<ReflectedFlags> {
if (this._flags)
return this._flags;
return this._flags = new ReflectedFlags(this.getMetadata('rt:f'));
}
/**
* True if this member is abstract.
*/
get isAbstract() {
return this.flags.isAbstract;
}
/**
* True if this member has private visibility.
*/
get isPrivate() {
return this.flags.isPrivate;
}
/**
* True if this member has public visibility.
*/
get isPublic() {
return this.visibility === 'public';
}
/**
* True if this member is specifically marked as public
* (as opposed to default visibility).
*/
get isMarkedPublic() {
return this.flags.isPublic;
}
/**
* True if this member has protected visibility.
*/
get isProtected() {
return this.flags.isProtected;
}
/**
* Get the visibility (accessibility) of this member.
* Can be 'public', 'protected', or 'private'
*/
get visibility(): Visibility {
return this.isMarkedPublic ? 'public'
: this.isProtected ? 'protected'
: this.isPrivate ? 'private'
: 'public';
}
/**
* Whether this member is marked as optional.
*/
get isOptional() {
return this.flags.isOptional;
}
}
export class ReflectedFunction<T extends Function = Function> implements ReflectedMetadataTarget {
private constructor(
readonly func: T
) {
}
private _flags: ReflectedFlags;
private _returnType: ReflectedTypeRef;
private _rawParameterMetadata: format.RtParameter[];
private _parameters: ReflectedFunctionParameter[];
private static reflectedFunctions = new WeakMap<object, ReflectedFunction>();
static for(func: Function): ReflectedFunction {
if (typeof func !== 'function')
throw new TypeError(`Passed value is not a function`);
let existing = this.reflectedFunctions.get(func);
if (!existing) {
this.reflectedFunctions.set(
func,
existing = new ReflectedFunction<Function>(func)
);
}
return existing;
}
/**
* Create a new ReflectedClass instance for the given type without sharing. Used during testing.
* @internal
**/
static new<FunctionT extends Function>(func: FunctionT) {
return new ReflectedFunction<FunctionT>(func);
}
matchesValue(object, errors: Error[] = [], context?: string) {
return object === this.func;
}
/**
* Check if the function has the given metadata key defined. This is equivalent
* to Reflect.hasMetadata(key, value, this.func)
* @param key
* @returns
*/
hasMetadata(key: string): boolean {
return Reflect.hasMetadata(key, this.func);
}
/**
* Get the specified metadata key for this function. This is equivalent
* to Reflect.getMetadata(key, value, this.func)
* @param key
* @returns
*/
getMetadata<T = any>(key: string): T {
return Reflect.getMetadata(key, this.func);
}
/**
* Define a metadata key for this function. This is equivalent
* to Reflect.defineMetadata(key, value, this.func)
* @param key The metadata key to define.
* @param value
*/
defineMetadata<T = any>(key: string, value: T) {
Reflect.defineMetadata(key, value, this.func);
return value;
}
/**
* Get or define a metadata item for this function. If the key already exists, its
* value is returned without calling the passed function. Otherwise the passed function
* is called and its value is saved to the given metadata key.
*
* @param key The metadata key to fetch
* @param definer A function which will define the value of the metadata
* @returns The value of the existing metadata key or the new value returned by the definer function
* which will also be defined as the appropriate metadata item on this function.
*/
metadata<T = any>(key: string, definer: () => T): T {
if (this.hasMetadata(key))
return this.getMetadata(key);
let value = definer();
this.defineMetadata(key, value);
return value;
}
/**
* Get the flags for this function.
*/
get flags(): Readonly<ReflectedFlags> {
if (this._flags)
return this._flags;
return this._flags = new ReflectedFlags(this.getMetadata('rt:f'));
}
/**
* @internal
*/
get rawParameterMetadata(): format.RtParameter[] {
if (this._rawParameterMetadata)
return this._rawParameterMetadata;
return this._rawParameterMetadata = this.getMetadata('rt:p') || [];
}
/**
* Names of the parameters for this function.
*/
get parameterNames() {
return this.rawParameterMetadata.map(x => x.n);
}
private _parameterTypes: ReflectedTypeRef[];
/**
* Types for the parameter types of this function.
*/
get parameterTypes() {
if (this._parameterTypes !== undefined)
return this._parameterTypes;
if (this.rawParameterMetadata !== undefined) {
return this._parameterTypes = this.rawParameterMetadata.map(param => {
return param.t ? ReflectedTypeRef.createFromRtRef(param.t()) : ReflectedTypeRef.createUnknown();
});
} else if (this.hasMetadata('design:paramtypes')) {
let params: Function[] = this.getMetadata('design:paramtypes');
return this._parameterTypes = (params || []).map(t => ReflectedTypeRef.createFromRtRef(() => t));
}
return [];
}
/**
* Retrieve the set of reflected parameters for this method.
*/
get parameters(): ReflectedFunctionParameter[] {
if (this._parameters)
return this._parameters;
return this._parameters = this.rawParameterMetadata.map((x, i) => new ReflectedFunctionParameter(this, x, i));
}
/**
* Get the parameter with the specified name
* @param name
* @returns The reflected parameter
*/
getParameter(name: string) {
return this.parameters.find(x => x.name === name);
}
/**
* Retrieve the return type of this function.
*/
get returnType(): ReflectedTypeRef {
if (this._returnType !== undefined)
return this._returnType;
let typeResolver = this.getMetadata('rt:t');
if (!typeResolver && this.hasMetadata('design:returntype')) {
let designReturnType = this.getMetadata('design:returntype');
typeResolver = () => (designReturnType || null);
}
if (!typeResolver)
return ReflectedTypeRef.createUnknown();
return this._returnType = ReflectedTypeRef.createFromRtRef(typeResolver());
}
/**
* True if the return type was inferred using the Typescript type checker. False if
* the return type was defined explicitly.
*/
get returnTypeInferred() {
return this.flags.isInferred;
}
/**
* True if this function is declared as async.
*/
get isAsync() {
return this.flags.isAsync;
}
/**
* True if this function is a variadic function.
*/
get isVariadic() {
return this.parameters.find(v => v.isRest) !== undefined;
}
}
/**
* Reflection data for a class method
*/
export class ReflectedMethod<T extends Function = Function> extends ReflectedMember {
private _returnType: ReflectedTypeRef;
private _rawParameterMetadata: format.RtParameter[];
private _parameters: ReflectedMethodParameter[];
matchesValue(object, errors: Error[] = [], context?: string) {
return object === this.func;
}
get func() {
if (this.isStatic)
return this.class[this.name];
else
return this.class.prototype[this.name];
}
/**
* @internal
*/
get rawParameterMetadata(): format.RtParameter[] {
if (this._rawParameterMetadata)
return this._rawParameterMetadata;
return this._rawParameterMetadata = this.getMetadata('rt:p') || [];
}
/**
* Retrieve the reflected method for the given method function.
* If the function is not a method, a TypeError is thrown.
* @param method
*/
static for(method: Function) {
if (!hasAnyFlag(method, [format.F_METHOD]))
throw new TypeError(`The function is not a method, or the class is not annotated with runtime type metadata`);
if (!Reflect.hasMetadata('rt:h', method))
throw new TypeError(`The function is a method, but is not annotated with a host class`);
let host = Reflect.getMetadata('rt:h', method);
if (!host)
throw new TypeError(`The method has a defined host, but it is null/undefined`);
return ReflectedClass.for(host()).getMethod(method.name);
}
/**
* Retrieve an array with the parameter names for this method.
*/
get parameterNames() {
return this.rawParameterMetadata.map(x => x.n);
}
private _parameterTypes: ReflectedTypeRef[];
/**
* Retrieve an array with the parameter types for this method.
*/
get parameterTypes() {
if (this._parameterTypes !== undefined)
return this._parameterTypes;
if (this.rawParameterMetadata !== undefined) {
return this._parameterTypes = this.rawParameterMetadata.map(param => {
return param.t ? ReflectedTypeRef.createFromRtRef(param.t()) : ReflectedTypeRef.createUnknown();
});
} else if (this.hasMetadata('design:paramtypes')) {
let params: Function[] = this.getMetadata('design:paramtypes');
return this._parameterTypes = (params || []).map(t => ReflectedTypeRef.createFromRtRef(() => t));
}
return [];
}
/**
* Retrieve the set of reflected parameters for this method.
*/
get parameters() {
if (this._parameters)
return this._parameters;
return this._parameters = this.rawParameterMetadata.map((x, i) => new ReflectedMethodParameter(this, x, i));
}
/**
* Get a reflected parameter by name
* @param name
* @returns The reflected parameter
*/
getParameter(name: string) {
return this.parameters.find(x => x.name === name);
}
/**
* Get the return type of this method.
*/
get returnType(): ReflectedTypeRef {
if (this._returnType !== undefined)
return this._returnType;
let typeResolver = this.getMetadata('rt:t');
if (!typeResolver && this.hasMetadata('design:returntype')) {
let designReturnType = this.getMetadata('design:returntype');
typeResolver = () => (designReturnType || null);
}
if (!typeResolver)
return ReflectedTypeRef.createUnknown();
return this._returnType = ReflectedTypeRef.createFromRtRef(typeResolver());
}
/**
* True if the return type was inferred using the Typescript type checker. False if
* the return type was defined explicitly.
*/
get returnTypeInferred() {
return this.flags.isInferred;
}
/**
* True if this method is declared as async.
*/
get isAsync() {
return this.flags.isAsync;
}
/**
* True if this function is a variadic function.
*/
get isVariadic() {
return this.parameters.find(v => v.isRest) !== undefined;
}
}
/**
* Represents a constructor for a specific type.
*/
export interface Constructor<T> extends Function {
new(...args): T;
}
/**
* Represents a reflected property of a class or interface.
*/
export class ReflectedProperty extends ReflectedMember {
private _type: ReflectedTypeRef;
/**
* Get the type of this property.
*/
get type(): ReflectedTypeRef {
if (this._type !== undefined)
return this._type;
let typeResolver: () => any;
if (this.hasMetadata('rt:t')) {
typeResolver = this.getMetadata('rt:t');
} else if (this.hasMetadata('design:type')) {
let designType = this.getMetadata('design:type');
typeResolver = () => designType;
}
if (!typeResolver)
return this._type = ReflectedTypeRef.createUnknown();
return this._type = ReflectedTypeRef.createFromRtRef(typeResolver());
}
/**
* True if this property is marked readonly.
*/
get isReadonly() {
return this.flags.isReadonly;
}
/**
* Check if the given value matches the type of this property, and would
* thus be a valid assignment.
* @param object
* @param errors
* @returns
*/
matchesValue(object, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
return this.type.matchesValue(object, options);
}
}
function getFlags(value): string {
if (!Reflect.hasMetadata('rt:f', value))
return '';
let flagsValue = Reflect.getMetadata('rt:f', value);
if (typeof flagsValue === 'string')
return flagsValue;
return '';
}
function hasAnyFlag(value, desiredFlags: string[]) {
let flags = getFlags(value);
return desiredFlags.some(x => flags.includes(x));
}
function hasAllFlags(value, desiredFlags: string[]) {
let flags = getFlags(value);
return desiredFlags.every(x => flags.includes(x));
}
export interface ReflectedMetadataTarget {
/**
* Check if the target has the given metadata key defined.
* @param key
* @returns
*/
hasMetadata(key: string): boolean;
/**
* Get the specified metadata key.
* @param key
* @returns
*/
getMetadata<T = any>(key: string): T;
/**
* Define a metadata key on this class.
* @param key
* @param value
* @returns
*/
defineMetadata<T = any>(key: string, value: T): T;
/**
* Get or define a metadata item for this target. If the key already exists, its
* value is returned without calling the passed function. Otherwise the passed function
* is called and its value is saved to the given metadata key.
*
* @param key The metadata key to fetch
* @param definer A function which will define the value of the metadata
* @returns The value of the existing metadata key or the new value returned by the definer function
* which will also be defined as the appropriate metadata item on this target.
*/
metadata<T = any>(key: string, definer: () => T): T;
}
/**
* Provides access to the known runtime type metadata for a particular class
* or Interface value (as obtained by reify<InterfaceT>()).
*/
@Sealed()
export class ReflectedClass<ClassT = any> implements ReflectedMetadataTarget {
/**
* Constructs a new ReflectedClass. Use ReflectedClass.for() to obtain a ReflectedClass.
*/
private constructor(
klass: Constructor<ClassT> | format.InterfaceToken
) {
this._class = klass;
}
/**
* Obtain a ReflectedClass for the given class constructor, Interface value or instance.
* @param constructorOrValue Can be a class constructor, Interface, or an instance of a class (in which case the
* instance's constructor will be used)
* @returns The ReflectedClass.
*/
static for<ClassT extends object>(constructorOrValue: Constructor<ClassT> | format.InterfaceToken | Function | InstanceType<Constructor<ClassT>>) {
let flags = getFlags(constructorOrValue);
if (flags.includes(format.F_INTERFACE))
return this.forConstructorOrInterface(<format.InterfaceToken>constructorOrValue);
else if (flags.includes(format.F_CLASS))
return this.forConstructorOrInterface(<Constructor<ClassT>>constructorOrValue);
else if (flags.includes(format.F_FUNCTION))
throw new TypeError(`Value is a function, use ReflectedFunction.for() or reflect(func) instead`);
// Heuristic based on shape
if (typeof constructorOrValue === 'function' || ('name' in constructorOrValue && 'prototype' in constructorOrValue && typeof constructorOrValue.identity === 'symbol'))
return this.forConstructorOrInterface(<Constructor<ClassT> | format.InterfaceToken>constructorOrValue);
// Assume it's an instance of a class
return this.forConstructorOrInterface(<Constructor<ClassT>>constructorOrValue.constructor);
}
private static reflectedClasses = new WeakMap<object, ReflectedClass>();
/**
* Create a new ReflectedClass instance for the given type without sharing. Used during testing.
* @internal
**/
static new<ClassT>(constructorOrInterface: Constructor<ClassT> | format.InterfaceToken) {
return new ReflectedClass<ClassT>(<Constructor<ClassT> | format.InterfaceToken>constructorOrInterface);
}
private static forConstructorOrInterface<ClassT>(constructorOrInterface: Constructor<ClassT> | format.InterfaceToken) {
let existing = this.reflectedClasses.get(constructorOrInterface);
if (!existing) {
this.reflectedClasses.set(
constructorOrInterface,
existing = new ReflectedClass<ClassT>(<Constructor<ClassT> | format.InterfaceToken>constructorOrInterface)
);
}
return existing;
}
private _class: Constructor<ClassT> | format.InterfaceToken;
private _ownMethods: ReflectedMethod[];
private _methods: ReflectedMethod[];
private _ownPropertyNames: string[];
private _ownMethodNames: string[];
private _methodNames: string[];
private _super: ReflectedClass;
private _rawParameterMetadata: format.RtParameter[];
private _parameters: ReflectedConstructorParameter[];
private _ownProperties: ReflectedProperty[];
private _properties: ReflectedProperty[];
private _flags: ReflectedFlags;
private _interfaces: ReflectedTypeRef[];
/**
* Get the interfaces that this class implements, or that this interface extends.
* Note that if the class implements another class as an interface, you will receive
* a class type reference for that, not an interface type reference.
*/
get interfaces() {
if (this._interfaces !== undefined)
return this._interfaces;
if (this.hasMetadata('rt:i')) {
return this._interfaces = (<(() => format.RtType)[]>this.getMetadata('rt:i'))
.map(resolver => resolver())
.filter(x => !!x)
.map(ref => ReflectedTypeRef.createFromRtRef(ref))
;
}
return [];
}
/**
* Check if this class implements the given interface. The parameter can be a reified interface
* reference or a class reference. Note that implementing a class is not the same as extending a class.
* Note that this will return true only if this class explicitly declares that an interface is implemented.
*
* @param interfaceType
* @returns boolean
*/
implements(interfaceType: format.InterfaceToken | Constructor<any>) {
return !!this.interfaces.find(i => typeof interfaceType === 'function'
? i.isClass(interfaceType) : i.isInterface(interfaceType));
}
/**
* Check if the given value matches the shape of this type, and thus would be a valid assignment.
* @param object
* @param errors
* @returns
*/
matchesValue(object, options?: MatchesValueOptions) {
options ??= {};
options.errors ??= [];
if (object === null || object === void 0) {
options.errors.push(new Error(`Value is undefined`));
return false;
}
if (typeof object !== 'object') {
options.errors.push(new Error(`Value must be an object`));
return false;
}
let matches = true;
if (globalThis.RTTI_TRACE === true)
console.log(`Type checking value against type '${this.class.name}'`);
for (let prop of this.properties) {
let hasValue = prop.name in object;
let value = object[prop.name];
if (!hasValue && !prop.isOptional) {
options.errors.push(new Error(`Property '${prop.name}' is missing in value`));
matches = false;
}
if (!hasValue)
continue;
let propMatch = prop.matchesValue(value, options);
if (globalThis.RTTI_TRACE === true)
console.log(` - ${this.class.name}#${prop.name} : ${prop.type} | valid(${JSON.stringify(value)}) => `
+ `${propMatch}`);
matches &&= propMatch;
}
let unaccountedProperties = Object.keys(object)
.filter(x => !this.properties.some(y => y.name === x) && !this.methods.some(y => y.name === x))
;
if (options.allowExtraProperties !== true && unaccountedProperties.length > 0) {
options.errors.push(
new Error(
`Object contains the following undeclared properties: `
+ `${unaccountedProperties.join(', ')}`
)
);
matches = false;
}
return matches;
}
/**
* Get the prototype object for this reflected class.
*/
get prototype() {
return this._class.prototype;
}
/**
* Get the class constructor for this reflected class.
*/
get class() {
return this._class;
}
/**
* Get the reflected superclass for this class. If this is an interface,
* this will always be undefined. If you are looking to access the classes/interfaces that
* an interface extends, use the "interfaces" property.
*/
get super(): ReflectedClass {
if (this._super !== undefined)
return this._super;
let parentClass = Object.getPrototypeOf(this.class.prototype)?.constructor ?? Object;
if (parentClass === Object)
return this._super = null;
else
return this._super = ReflectedClass.for(parentClass);
}
private _hasPropertyNamesMeta = false;
/**
* Check if the function has the given metadata key defined. This is equivalent
* to Reflect.hasMetadata(key, this.class)
* @param key
* @returns
*/
hasMetadata(key: string): boolean {
return Reflect.hasMetadata(key, this.class);
}
/**
* Get the specified metadata key. This is equivalent to Reflect.getMetadata(key, this.class).
* @param key
* @returns
*/
getMetadata<T = any>(key: string): T {
return Reflect.getMetadata(key, this.class);
}
/**
* Define a metadata key on this class. This is equivalent to Reflect.defineMetadata(key, value, this.class).
* @param key
* @param value
* @returns
*/
defineMetadata<T = any>(key: string, value: T): T {
Reflect.defineMetadata(key, value, this.class);
return value;
}
/**
* Get or define a metadata item for this class/interface. If the key already exists, its
* value is returned without calling the passed function. Otherwise the passed function
* is called and its value is saved to the given metadata key.
*
* @param key The metadata key to fetch
* @param definer A function which will define the value of the metadata
* @returns The value of the existing metadata key or the new value returned by the definer function
* which will also be defined as the appropriate metadata item on this class/interface.
*/
metadata<T = any>(key: string, definer: () => T): T {
if (this.hasMetadata(key))
return this.getMetadata(key);
let value = definer();
this.defineMetadata(key, value);
return value;
}
/**
* Define a metadata key on this class's prototype object. This is equivalent to Reflect.defineMetadata(key, value, this.class.prototype)
* @param key
* @param value
* @returns
*/
definePrototypeMetadata<T = any>(key: string, value: T): T {
Reflect.defineMetadata(key, value, this.class.prototype);
return value;
}
/**
* Retrieve the set of property names that are defined directly on this class, excluding
* those which are inherited.
*/
get ownPropertyNames(): string[] {
if (this._ownPropertyNames)
return this._ownPropertyNames;
let propertyNames: string[];
if (this.hasMetadata('rt:P')) {
propertyNames = this.getMetadata('rt:P');
this._hasPropertyNamesMeta = !!propertyNames;
} else {
propertyNames = Object.getOwnPropertyNames(this.class.prototype)
.filter(x => x !== 'constructor')
.filter(x => {
// All properties which have `get` defined must be considered properties, not methods.
// We need to avoid executing getters inadvertently while determining the type of the property.
// https://github.com/typescript-rtti/typescript-rtti/issues/52
let descriptor = Object.getOwnPropertyDescriptor(this.class.prototype, x);
if (descriptor.get)
return true;
return typeof this.class.prototype[x] === 'function';
});
}
return this._ownPropertyNames = propertyNames || [];
}
/**
* Retrieve the set of method names that are defined directly on this class, excluding
* those which are inherited.
*/
get ownMethodNames(): string[] {
if (this._ownMethodNames)
return this._ownMethodNames;
let methodNames = this.getMetadata('rt:m');
if (!methodNames) {
methodNames = Object.getOwnPropertyNames(this.class.prototype)
.filter(x => x !== 'constructor')
.filter(x => {
// All properties which have `get` defined must be considered properties, not methods.
// We need to avoid executing getters inadvertently while determining the type of the property.
// https://github.com/typescript-rtti/typescript-rtti/issues/52
let descriptor = Object.getOwnPropertyDescriptor(this.class.prototype, x);
if (descriptor.get)
return false;
return typeof this.class.prototype[x] === 'function'
});
}
return this._ownMethodNames = methodNames;
}
private _ownStaticPropertyNames: string[];
private _hasStaticPropertyNameMeta = false;
/**
* Retrieve the set of static property names that are defined directly on this class, excluding
* those which are inherited. Always empty for interfaces.
*/
get ownStaticPropertyNames(): string[] {
if (this._ownStaticPropertyNames)
return this._ownStaticPropertyNames;
let ownStaticPropertyNames = this.getMetadata('rt:SP');
this._hasStaticPropertyNameMeta = !!ownStaticPropertyNames;
if (!ownStaticPropertyNames) {
this._hasStaticPropertyNameMeta = false;
ownStaticPropertyNames = Object.getOwnPropertyNames(this.class)
.filter(x => !['length', 'prototype', 'name'].includes(x))
.filter(x => typeof this.class[x] !== 'function')
;
}
return this._ownStaticPropertyNames = ownStaticPropertyNames;
}
private _ownStaticMethodNames: string[];
/**
* Retrieve the set of static method names that are defined directly on this class,
* excluding those which are inherited. Always empty for interfaces
*/
get ownStaticMethodNames(): string[] {
if (this._ownStaticMethodNames)
return this._ownStaticMethodNames;
let ownStaticMethodNames = this.getMetadata('rt:Sm');
if (!ownStaticMethodNames) {
ownStaticMethodNames = Object.getOwnPropertyNames(this.class)
.filter(x => !['length', 'prototype', 'name'].includes(x))
.filter(x => typeof this.class[x] === 'function');
}
return this._ownStaticMethodNames = ownStaticMethodNames;
}
/**
* Retrieve the set of flags for this class/interface. Use this to check for modifiers or other properties
* of the class/interface.
*/
get flags(): Readonly<ReflectedFlags> {
if (this._flags)
return this._flags;
return this._flags = new ReflectedFlags(this.getMetadata('rt:f'));
}
/**
* True if the class is marked abstract.
*/
get isAbstract() {
return this.flags.isAbstract;
}
/**
* Get the instance method names for this reflected class/interface.
*/
get methodNames(): string[] {
if (this._methodNames)
return this._methodNames;
return this._methodNames = superMergeNames(
this.ownMethodNames,
this.super?.methodNames ?? []
);
}
private _staticPropertyNames: string[];
/**
* Get the static property names defined for this reflected class. Always empty for interfaces.
*/
get staticPropertyNames(): string[] {
if (this._staticPropertyNames)
return this._staticPropertyNames;
return this._staticPropertyNames = superMergeNames(
this.ownStaticPropertyNames,
this.super?.staticPropertyNames ?? []
);
}
private _staticMethodNames: string[];
/**
* Retrieve an array of the names of static methods defined on this reflected class.
* Always empty for interfaces.
*/
get staticMethodNames(): string[] {
if (this._staticMethodNames)
return this._staticMethodNames;
return this._staticMethodNames = superMergeNames(
this.ownStaticMethodNames,
this.super?.staticMethodNames ?? []
);
}
private _propertyNames: string[];
/**
* Retrieve an array of the names of instance properties defined on this class/interface
*/
get propertyNames(): string[] {
if (this._propertyNames)
return this._propertyNames;
return this._propertyNames = superMergeNames(
this.ownPropertyNames,
this.super?.propertyNames ?? []
);
}
/**
* Retrieve the set of reflected methods defined directly on this class/interface.
*/
get ownMethods(): ReflectedMethod[] {
if (this._ownMethods)
return this._ownMethods;
return this._ownMethods = this.ownMethodNames.map(name => new ReflectedMethod(<any>this, name, false));
}
private _ownStaticProperties: ReflectedProperty[];
/**
* Retrieve the set of reflected static properties defined directly on this class. Always empty
* for interfaces.
*/
get ownStaticProperties(): ReflectedProperty[] {
if (this._ownStaticProperties)
return this._ownStaticProperties;
return this._ownStaticProperties = this.staticPropertyNames.map(x => new ReflectedProperty(<any>this, x, true));
}
private _ownStaticMethods: ReflectedMethod[];
/**
* Retrieve the set of reflected static methods defined directly on this class. Always
* empty for interfaces.
*/
get ownStaticMethods(): ReflectedMethod[] {
if (this._ownStaticMethods)
return this._ownStaticMethods;
return this._ownStaticMethods = this.ownStaticMethodNames.map(name => new ReflectedMethod(<any>this, name, true));
}
/**
* Retrieve the set of reflected instance methods defined on this class/interface.
*/
get methods(): ReflectedMethod[] {
if (this._methods)
return this._methods;
return this._methods = superMergeElements(
this.ownMethods,
this.super?.methods ?? []
);
}
private _staticProperties: ReflectedProperty[];
/**
* Retrieve the set of reflected static properties defined on this class. Always
* empty for interfaces.
*/
get staticProperties() {
if (this._staticProperties)
return this._staticProperties;
return this._staticProperties = superMergeElements(
this.ownStaticProperties,
this.super?.staticProperties ?? []
);
}
private _staticMethods: ReflectedMethod[];
/**
* Retrieve the set of reflected static methods defined on this class. Always
* empty for interfaces
*/
get staticMethods(): ReflectedMethod[] {
if (this._staticMethods)
return this._staticMethods;
return this._staticMethods = superMergeElements(
this.ownStaticMethods,
this.super?.staticMethods ?? []
);
}
/**
* Retrieve the set of reflected instance properties defined directly on this class/interface
*/
get ownProperties(): ReflectedProperty[] {
if (this._ownProperties)
return this._ownProperties;
return this._ownProperties = this.ownPropertyNames.map(name => new ReflectedProperty(<any>this, name, false));
}
/**
* Retrieve the set of reflected instance methods defined on this class/interface
*/
get properties(): ReflectedProperty[] {
if (this._properties)
return this._properties;
return this._properties = superMergeElements(
this.ownProperties,
this.super?.properties ?? []
);
}
private get rawParameterMetadata(): format.RtParameter[] {
if (this._rawParameterMetadata)
return this._rawParameterMetadata;
let rawParams = this.getMetadata('rt:p');
if (rawParams === void 0 && this.hasMetadata('design:paramtypes')) {
let types = this.getMetadata('design:paramtypes');
let names = getParameterNames(<Function>this.class);
rawParams = names.map((n, i) => ({ n, t: () => types[i] }));
}
return this._rawParameterMetadata = rawParams || [];
}
/**
* Retrieve an array of the parameter names for this class's constructor.
*/
get parameterNames() {
return this.rawParameterMetadata.map(x => x.n);
}
/**
* Retrieve an array of the types for the parameters of this class's
* constructor.
*/
get parameterTypes() {
return this.rawParameterMetadata.map(x => x.t);
}
/**
* Retrieve the set of reflected parameters for this class's constructor.
*/
get parameters(): ReflectedConstructorParameter[] {
if (this._parameters)
return this._parameters;
return this._parameters = this.rawParameterMetadata.map((x, i) => new ReflectedConstructorParameter(<any>this, x, i));
}
/**
* Get a reflected constructor parameter by name.
* @param name
* @returns
*/
getParameter(name: string) {
return this.parameters.find(x => x.name === name);
}
/**
* Get a reflected instance method (declared directly on this class) by name
* @param name
* @returns
*/
getOwnMethod(name: string) {
return this.ownMethods.find(x => x.name === name);
}
/**
* Get a reflected instance method by name
* @param name
* @returns
*/
getMethod(name: string) {
return this.methods.find(x => x.name === name);
}
/**
* Get a reflected static method by name
* @param name
* @returns
*/
getStaticMethod(name: string) {
return this.staticMethods.find(x => x.name === name);
}
private _dynamicStaticProperties = new Map<string, ReflectedProperty>();
/**
* Get a reflected static property (declared directly on this class) by name
* @param name
* @returns
*/
getOwnStaticProperty(name: string) {
let matchingProp = this.ownStaticProperties.find(x => x.name === name);
if (matchingProp)
return matchingProp;
if (!this._hasStaticPropertyNameMeta) {
if (this._dynamicStaticProperties.has(name))
return this._dynamicStaticProperties.get(name);
let prop = new ReflectedProperty(this, name, true);
this._dynamicStaticProperties.set(name, prop);
return prop;
}
}
/**
* Get a reflected static property by name
* @param name
* @returns
*/
getStaticProperty(name: string) {
let matchingProp = this.staticProperties.find(x => x.name === name);
if (matchingProp)
return matchingProp;
if (!this._hasStaticPropertyNameMeta) {
if (this._dynamicStaticProperties.has(name))
return this._dynamicStaticProperties.get(name);
let prop = new ReflectedProperty(this, name, true);
this._dynamicStaticProperties.set(name, prop);
return prop;
}
}
/**
* Get a reflected instance property (declared directly on this class) by name
* @param name
* @returns
*/
getOwnProperty(name: string) {
let matchingProp = this.ownProperties.find(x => x.name === name);
if (matchingProp)
return matchingProp;
if (!this._hasPropertyNamesMeta) {
if (this._dynamicProperties.has(name))
return this._dynamicProperties.get(name);
let prop = new ReflectedProperty(this, name, false);
this._dynamicProperties.set(name, prop);
return prop;
}
}
private _dynamicProperties = new Map<string, ReflectedProperty>();
/**
* Get a reflected instance property by name
* @param name
* @returns
*/
getProperty(name: string): ReflectedProperty {
let matchingProp = this.properties.find(x => x.name === name);
if (matchingProp)
return matchingProp;
if (!this._hasPropertyNamesMeta) {
if (this._dynamicProperties.has(name))
return this._dynamicProperties.get(name);
let prop = new ReflectedProperty(this, name, false);
this._dynamicProperties.set(name, prop);
return prop;
}
}
}
/**
* Returns true if the class (or the class of the given value) implement the given interface.
* Note that interfaceType can be a class constructor. Implementing a class is not the same as extending a class.
*
* @param value The value to check. Can be a constructor or a value (whose constructor will be checked)
* @param interfaceType The interface type to use. Can be a class constructor or an Interface object.
* @returns True if the interface is implemented
*/
export function implementsInterface(value, interfaceType: format.InterfaceToken | Constructor<any>) {
if (value === null || value === undefined || !['object', 'function'].includes(typeof value))
return false;
if (interfaceType === null || interfaceType === undefined)
throw new TypeError(`Interface type must not be undefined`);
if (typeof value === 'object')
return ReflectedClass.for(value.constructor).implements(interfaceType);
else if (typeof value === 'function')
return ReflectedClass.for(value).implements(interfaceType);
}
/**
* Returns true if the given value matches the shape of the interface / class passed as interfaceType.
*
* @param value
* @param interfaceType
* @returns True if the value is the correct shape
*/
export function matchesShape(value, interfaceType: format.InterfaceToken | Constructor<any>) {
if (interfaceType === null || interfaceType === undefined)
throw new TypeError(`Interface type must not be undefined`);
return ReflectedClass.for(interfaceType).matchesValue(value);
}
/**
* Get the reflected call site
* @returns The reflected call site
*/
export function reflect(value: CallSite): ReflectedCallSite;
/**
* Get the reflected interface object for the given interface (identified by T)
* @param callSite Do not pass a value here. This opts in to call site reflection.
* @returns The reflected interface
* @rtti:callsite 1
*/
export function reflect<T>(unused?: never, callSite?: CallSite): ReflectedTypeRef;
/**
* Get the reflected class for the given constructor or instance.
* @param value A constructor, Interface value, or an instance of a class
* @returns The reflected class
*/
export function reflect<T>(value: Constructor<T>): ReflectedClass<Constructor<T>>;
export function reflect<T extends Function>(value: T): (ReflectedFunction<T> | ReflectedMethod<T>);
export function reflect<T>(value: T): ReflectedClass<Constructor<T>>;
/**
* @rtti:callsite 1
*/
export function reflect(value: any = NotProvided, callSite?: CallSite) {
if (value === NotProvided && !callSite) {
throw new Error(`reflect<T>() can only be used when project is built with the typescript-rtti transformer`);
}
if (!value)
throw new TypeError(`Could not reflect on null/undefined`);
if (isCallSite(value))
return new ReflectedCallSite(value);
if (value === NotProvided && isCallSite(callSite))
return new ReflectedCallSite(callSite).typeParameters[0];
if (!['object', 'function'].includes(typeof value)) {
// Primitive value
return reflect(value.constructor);
}
let flags = getFlags(value);
if (flags.includes(format.F_FUNCTION))
return ReflectedFunction.for(value);
if (flags.includes(format.F_METHOD))
return ReflectedMethod.for(value);
if (typeof value === 'function' && !value.prototype)
return ReflectedFunction.for(value);
return ReflectedClass.for(value);
}
export interface CallSite {
TΦ: 'c';
}
export class ReflectedCallSite {
constructor(callSite: CallSite) {
this.callSite = <format.RtCallSite>callSite;
}
private callSite: format.RtCallSite;
private _parameters: ReflectedTypeRef[];
get parameters() {
if (!this._parameters)
this._parameters = this.callSite.p.map(x => ReflectedTypeRef.createFromRtRef(x));
return this._parameters;
}
private _typeParameters: ReflectedTypeRef[];
get typeParameters() {
if (!this._typeParameters) {
this._typeParameters = this.callSite.tp.map(x => ReflectedTypeRef.createFromRtRef(x));
}
return this._typeParameters;
}
// private _target : ReflectedTypeRef;
// get target() {
// if (!this._target)
// this._target = ReflectedTypeRef.createFromRtRef(this.callSite.t);
// return this._target;
// }
// private _return : ReflectedTypeRef;
// get return() {
// if (!this._return)
// this._return = ReflectedTypeRef.createFromRtRef(this.callSite.r);
// return this._return;
// }
}
function superMergeElements<T extends { name: string }>(ownSet: T[], superSet: T[]): T[] {
return superSet.map(superItem => ownSet.find(ownItem => ownItem.name === superItem.name) ?? superItem)
.concat(ownSet.filter(ownItem => !superSet.some(superItem => ownItem.name === superItem.name)));
}
function superMergeNames(ownSet: string[], superSet: string[]): string[] {
return superSet.concat(ownSet.filter(x => !superSet.includes(x)));
} |