@genesislcap/foundation-errors 14.237.2-alpha-78ebbc0.0 → 14.238.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.48.0"
8
+ "packageVersion": "7.34.9"
9
9
  }
10
10
  ]
11
11
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.48.0",
4
+ "toolVersion": "7.34.9",
5
5
  "schemaVersion": 1011,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -1635,21 +1635,17 @@
1635
1635
  "extendsTokenRanges": []
1636
1636
  },
1637
1637
  {
1638
- "kind": "Function",
1639
- "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerAnchor:function(1)",
1638
+ "kind": "Variable",
1639
+ "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerAnchor:var",
1640
1640
  "docComment": "/**\n * Get the error banner anchor to attach the banner to\n *\n * @param element - The element to start searching from\n *\n * @returns \n *\n * @public\n */\n",
1641
1641
  "excerptTokens": [
1642
1642
  {
1643
1643
  "kind": "Content",
1644
- "text": "getErrorBannerAnchor: (element: "
1644
+ "text": "getErrorBannerAnchor: "
1645
1645
  },
1646
1646
  {
1647
1647
  "kind": "Content",
1648
- "text": "any"
1649
- },
1650
- {
1651
- "kind": "Content",
1652
- "text": ") => "
1648
+ "text": "(element: any) => "
1653
1649
  },
1654
1650
  {
1655
1651
  "kind": "Reference",
@@ -1662,32 +1658,26 @@
1662
1658
  }
1663
1659
  ],
1664
1660
  "fileUrlPath": "src/error-util.ts",
1665
- "returnTypeTokenRange": {
1666
- "startIndex": 3,
1667
- "endIndex": 5
1668
- },
1661
+ "isReadonly": true,
1669
1662
  "releaseTag": "Public",
1670
- "overloadIndex": 1,
1671
- "parameters": [
1672
- {
1673
- "parameterName": "element",
1674
- "parameterTypeTokenRange": {
1675
- "startIndex": 1,
1676
- "endIndex": 2
1677
- },
1678
- "isOptional": false
1679
- }
1680
- ],
1681
- "name": "getErrorBannerAnchor"
1663
+ "name": "getErrorBannerAnchor",
1664
+ "variableTypeTokenRange": {
1665
+ "startIndex": 1,
1666
+ "endIndex": 4
1667
+ }
1682
1668
  },
1683
1669
  {
1684
- "kind": "Function",
1685
- "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerBuilder:function(1)",
1670
+ "kind": "Variable",
1671
+ "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerBuilder:var",
1686
1672
  "docComment": "/**\n * Get error banner builder instance\n *\n * @public\n */\n",
1687
1673
  "excerptTokens": [
1688
1674
  {
1689
1675
  "kind": "Content",
1690
- "text": "getErrorBannerBuilder: () => "
1676
+ "text": "getErrorBannerBuilder: "
1677
+ },
1678
+ {
1679
+ "kind": "Content",
1680
+ "text": "() => "
1691
1681
  },
1692
1682
  {
1693
1683
  "kind": "Reference",
@@ -1696,23 +1686,26 @@
1696
1686
  }
1697
1687
  ],
1698
1688
  "fileUrlPath": "src/banner/error-banner-builder.ts",
1699
- "returnTypeTokenRange": {
1700
- "startIndex": 1,
1701
- "endIndex": 2
1702
- },
1689
+ "isReadonly": true,
1703
1690
  "releaseTag": "Public",
1704
- "overloadIndex": 1,
1705
- "parameters": [],
1706
- "name": "getErrorBannerBuilder"
1691
+ "name": "getErrorBannerBuilder",
1692
+ "variableTypeTokenRange": {
1693
+ "startIndex": 1,
1694
+ "endIndex": 3
1695
+ }
1707
1696
  },
1708
1697
  {
1709
- "kind": "Function",
1710
- "canonicalReference": "@genesislcap/foundation-errors!getErrorBuilder:function(1)",
1698
+ "kind": "Variable",
1699
+ "canonicalReference": "@genesislcap/foundation-errors!getErrorBuilder:var",
1711
1700
  "docComment": "/**\n * Returns a new ErrorBuilder instance\n *\n * @public\n */\n",
1712
1701
  "excerptTokens": [
1713
1702
  {
1714
1703
  "kind": "Content",
1715
- "text": "getErrorBuilder: () => "
1704
+ "text": "getErrorBuilder: "
1705
+ },
1706
+ {
1707
+ "kind": "Content",
1708
+ "text": "() => "
1716
1709
  },
1717
1710
  {
1718
1711
  "kind": "Reference",
@@ -1721,31 +1714,26 @@
1721
1714
  }
1722
1715
  ],
1723
1716
  "fileUrlPath": "src/error-builder.ts",
1724
- "returnTypeTokenRange": {
1725
- "startIndex": 1,
1726
- "endIndex": 2
1727
- },
1717
+ "isReadonly": true,
1728
1718
  "releaseTag": "Public",
1729
- "overloadIndex": 1,
1730
- "parameters": [],
1731
- "name": "getErrorBuilder"
1719
+ "name": "getErrorBuilder",
1720
+ "variableTypeTokenRange": {
1721
+ "startIndex": 1,
1722
+ "endIndex": 3
1723
+ }
1732
1724
  },
1733
1725
  {
1734
- "kind": "Function",
1735
- "canonicalReference": "@genesislcap/foundation-errors!getErrorContainer:function(1)",
1726
+ "kind": "Variable",
1727
+ "canonicalReference": "@genesislcap/foundation-errors!getErrorContainer:var",
1736
1728
  "docComment": "/**\n * Get/Create the error container in the DOM\n *\n * @param id - The id of the container\n *\n * @param tagName - The tag name to create prefix for the design system provider\n *\n * @returns \n *\n * @public\n */\n",
1737
1729
  "excerptTokens": [
1738
1730
  {
1739
1731
  "kind": "Content",
1740
- "text": "getErrorContainer: (id: "
1732
+ "text": "getErrorContainer: "
1741
1733
  },
1742
1734
  {
1743
1735
  "kind": "Content",
1744
- "text": "string"
1745
- },
1746
- {
1747
- "kind": "Content",
1748
- "text": ", tagName: "
1736
+ "text": "(id: string, tagName: "
1749
1737
  },
1750
1738
  {
1751
1739
  "kind": "Reference",
@@ -1763,40 +1751,26 @@
1763
1751
  }
1764
1752
  ],
1765
1753
  "fileUrlPath": "src/error-util.ts",
1766
- "returnTypeTokenRange": {
1767
- "startIndex": 5,
1768
- "endIndex": 6
1769
- },
1754
+ "isReadonly": true,
1770
1755
  "releaseTag": "Public",
1771
- "overloadIndex": 1,
1772
- "parameters": [
1773
- {
1774
- "parameterName": "id",
1775
- "parameterTypeTokenRange": {
1776
- "startIndex": 1,
1777
- "endIndex": 2
1778
- },
1779
- "isOptional": false
1780
- },
1781
- {
1782
- "parameterName": "tagName",
1783
- "parameterTypeTokenRange": {
1784
- "startIndex": 3,
1785
- "endIndex": 4
1786
- },
1787
- "isOptional": false
1788
- }
1789
- ],
1790
- "name": "getErrorContainer"
1756
+ "name": "getErrorContainer",
1757
+ "variableTypeTokenRange": {
1758
+ "startIndex": 1,
1759
+ "endIndex": 5
1760
+ }
1791
1761
  },
1792
1762
  {
1793
- "kind": "Function",
1794
- "canonicalReference": "@genesislcap/foundation-errors!getErrorDetails:function(1)",
1763
+ "kind": "Variable",
1764
+ "canonicalReference": "@genesislcap/foundation-errors!getErrorDetails:var",
1795
1765
  "docComment": "/**\n * Retrieves the error details from an ErrorStructure object\n *\n * @param details - The ErrorStructure object\n *\n * @returns The title and error details concatenated as a string, or default values ('Error: Something went wrong') if not present\n *\n * @public\n */\n",
1796
1766
  "excerptTokens": [
1797
1767
  {
1798
1768
  "kind": "Content",
1799
- "text": "getErrorDetails: (details: "
1769
+ "text": "getErrorDetails: "
1770
+ },
1771
+ {
1772
+ "kind": "Content",
1773
+ "text": "(details: "
1800
1774
  },
1801
1775
  {
1802
1776
  "kind": "Reference",
@@ -1805,40 +1779,30 @@
1805
1779
  },
1806
1780
  {
1807
1781
  "kind": "Content",
1808
- "text": ") => "
1809
- },
1810
- {
1811
- "kind": "Content",
1812
- "text": "string"
1782
+ "text": ") => string"
1813
1783
  }
1814
1784
  ],
1815
1785
  "fileUrlPath": "src/error-util.ts",
1816
- "returnTypeTokenRange": {
1817
- "startIndex": 3,
1818
- "endIndex": 4
1819
- },
1786
+ "isReadonly": true,
1820
1787
  "releaseTag": "Public",
1821
- "overloadIndex": 1,
1822
- "parameters": [
1823
- {
1824
- "parameterName": "details",
1825
- "parameterTypeTokenRange": {
1826
- "startIndex": 1,
1827
- "endIndex": 2
1828
- },
1829
- "isOptional": false
1830
- }
1831
- ],
1832
- "name": "getErrorDetails"
1788
+ "name": "getErrorDetails",
1789
+ "variableTypeTokenRange": {
1790
+ "startIndex": 1,
1791
+ "endIndex": 4
1792
+ }
1833
1793
  },
1834
1794
  {
1835
- "kind": "Function",
1836
- "canonicalReference": "@genesislcap/foundation-errors!getErrorDialogBuilder:function(1)",
1795
+ "kind": "Variable",
1796
+ "canonicalReference": "@genesislcap/foundation-errors!getErrorDialogBuilder:var",
1837
1797
  "docComment": "/**\n * Returns an instance of ErrorDialogBuilder\n *\n * @public\n */\n",
1838
1798
  "excerptTokens": [
1839
1799
  {
1840
1800
  "kind": "Content",
1841
- "text": "getErrorDialogBuilder: () => "
1801
+ "text": "getErrorDialogBuilder: "
1802
+ },
1803
+ {
1804
+ "kind": "Content",
1805
+ "text": "() => "
1842
1806
  },
1843
1807
  {
1844
1808
  "kind": "Reference",
@@ -1847,23 +1811,26 @@
1847
1811
  }
1848
1812
  ],
1849
1813
  "fileUrlPath": "src/dialog/error-dialog-builder.ts",
1850
- "returnTypeTokenRange": {
1851
- "startIndex": 1,
1852
- "endIndex": 2
1853
- },
1814
+ "isReadonly": true,
1854
1815
  "releaseTag": "Public",
1855
- "overloadIndex": 1,
1856
- "parameters": [],
1857
- "name": "getErrorDialogBuilder"
1816
+ "name": "getErrorDialogBuilder",
1817
+ "variableTypeTokenRange": {
1818
+ "startIndex": 1,
1819
+ "endIndex": 3
1820
+ }
1858
1821
  },
1859
1822
  {
1860
- "kind": "Function",
1861
- "canonicalReference": "@genesislcap/foundation-errors!getLoglevel:function(1)",
1823
+ "kind": "Variable",
1824
+ "canonicalReference": "@genesislcap/foundation-errors!getLoglevel:var",
1862
1825
  "docComment": "/**\n * Retrieves the log level from an ErrorStructure object\n *\n * @param details - The ErrorStructure object\n *\n * @returns The log level or the default value (LogLevel.Error) if not present\n *\n * @public\n */\n",
1863
1826
  "excerptTokens": [
1864
1827
  {
1865
1828
  "kind": "Content",
1866
- "text": "getLoglevel: (details: "
1829
+ "text": "getLoglevel: "
1830
+ },
1831
+ {
1832
+ "kind": "Content",
1833
+ "text": "(details: "
1867
1834
  },
1868
1835
  {
1869
1836
  "kind": "Reference",
@@ -1881,32 +1848,26 @@
1881
1848
  }
1882
1849
  ],
1883
1850
  "fileUrlPath": "src/error-util.ts",
1884
- "returnTypeTokenRange": {
1885
- "startIndex": 3,
1886
- "endIndex": 4
1887
- },
1851
+ "isReadonly": true,
1888
1852
  "releaseTag": "Public",
1889
- "overloadIndex": 1,
1890
- "parameters": [
1891
- {
1892
- "parameterName": "details",
1893
- "parameterTypeTokenRange": {
1894
- "startIndex": 1,
1895
- "endIndex": 2
1896
- },
1897
- "isOptional": false
1898
- }
1899
- ],
1900
- "name": "getLoglevel"
1853
+ "name": "getLoglevel",
1854
+ "variableTypeTokenRange": {
1855
+ "startIndex": 1,
1856
+ "endIndex": 5
1857
+ }
1901
1858
  },
1902
1859
  {
1903
- "kind": "Function",
1904
- "canonicalReference": "@genesislcap/foundation-errors!getNotificationBuilder:function(1)",
1860
+ "kind": "Variable",
1861
+ "canonicalReference": "@genesislcap/foundation-errors!getNotificationBuilder:var",
1905
1862
  "docComment": "/**\n * Get notification builder instance\n *\n * @public\n */\n",
1906
1863
  "excerptTokens": [
1907
1864
  {
1908
1865
  "kind": "Content",
1909
- "text": "getNotificationBuilder: () => "
1866
+ "text": "getNotificationBuilder: "
1867
+ },
1868
+ {
1869
+ "kind": "Content",
1870
+ "text": "() => "
1910
1871
  },
1911
1872
  {
1912
1873
  "kind": "Reference",
@@ -1915,23 +1876,26 @@
1915
1876
  }
1916
1877
  ],
1917
1878
  "fileUrlPath": "src/notification/notification-builder.ts",
1918
- "returnTypeTokenRange": {
1919
- "startIndex": 1,
1920
- "endIndex": 2
1921
- },
1879
+ "isReadonly": true,
1922
1880
  "releaseTag": "Public",
1923
- "overloadIndex": 1,
1924
- "parameters": [],
1925
- "name": "getNotificationBuilder"
1881
+ "name": "getNotificationBuilder",
1882
+ "variableTypeTokenRange": {
1883
+ "startIndex": 1,
1884
+ "endIndex": 3
1885
+ }
1926
1886
  },
1927
1887
  {
1928
- "kind": "Function",
1929
- "canonicalReference": "@genesislcap/foundation-errors!getSnackbarBuilder:function(1)",
1888
+ "kind": "Variable",
1889
+ "canonicalReference": "@genesislcap/foundation-errors!getSnackbarBuilder:var",
1930
1890
  "docComment": "/**\n * Get snackbar builder instance\n *\n * @public\n */\n",
1931
1891
  "excerptTokens": [
1932
1892
  {
1933
1893
  "kind": "Content",
1934
- "text": "getSnackbarBuilder: () => "
1894
+ "text": "getSnackbarBuilder: "
1895
+ },
1896
+ {
1897
+ "kind": "Content",
1898
+ "text": "() => "
1935
1899
  },
1936
1900
  {
1937
1901
  "kind": "Reference",
@@ -1940,14 +1904,13 @@
1940
1904
  }
1941
1905
  ],
1942
1906
  "fileUrlPath": "src/snackbar/snackbar-builder.ts",
1943
- "returnTypeTokenRange": {
1944
- "startIndex": 1,
1945
- "endIndex": 2
1946
- },
1907
+ "isReadonly": true,
1947
1908
  "releaseTag": "Public",
1948
- "overloadIndex": 1,
1949
- "parameters": [],
1950
- "name": "getSnackbarBuilder"
1909
+ "name": "getSnackbarBuilder",
1910
+ "variableTypeTokenRange": {
1911
+ "startIndex": 1,
1912
+ "endIndex": 3
1913
+ }
1951
1914
  },
1952
1915
  {
1953
1916
  "kind": "Class",
@@ -2199,13 +2162,17 @@
2199
2162
  "implementsTokenRanges": []
2200
2163
  },
2201
2164
  {
2202
- "kind": "Function",
2203
- "canonicalReference": "@genesislcap/foundation-errors!showBanner:function(1)",
2165
+ "kind": "Variable",
2166
+ "canonicalReference": "@genesislcap/foundation-errors!showBanner:var",
2204
2167
  "docComment": "/**\n * Shows the error dialog\n *\n * @param error - The ErrorStructure object\n *\n * @param tagName - The tag name to create prefix for the design system provider & error component\n *\n * @returns \n *\n * @public\n */\n",
2205
2168
  "excerptTokens": [
2206
2169
  {
2207
2170
  "kind": "Content",
2208
- "text": "showBanner: (error: "
2171
+ "text": "showBanner: "
2172
+ },
2173
+ {
2174
+ "kind": "Content",
2175
+ "text": "(error: "
2209
2176
  },
2210
2177
  {
2211
2178
  "kind": "Reference",
@@ -2232,56 +2199,30 @@
2232
2199
  },
2233
2200
  {
2234
2201
  "kind": "Content",
2235
- "text": ") => "
2236
- },
2237
- {
2238
- "kind": "Content",
2239
- "text": "void"
2202
+ "text": ") => void"
2240
2203
  }
2241
2204
  ],
2242
2205
  "fileUrlPath": "src/banner/error-banner-launcher.ts",
2243
- "returnTypeTokenRange": {
2244
- "startIndex": 7,
2245
- "endIndex": 8
2246
- },
2206
+ "isReadonly": true,
2247
2207
  "releaseTag": "Public",
2248
- "overloadIndex": 1,
2249
- "parameters": [
2250
- {
2251
- "parameterName": "error",
2252
- "parameterTypeTokenRange": {
2253
- "startIndex": 1,
2254
- "endIndex": 2
2255
- },
2256
- "isOptional": false
2257
- },
2258
- {
2259
- "parameterName": "tagName",
2260
- "parameterTypeTokenRange": {
2261
- "startIndex": 3,
2262
- "endIndex": 4
2263
- },
2264
- "isOptional": false
2265
- },
2266
- {
2267
- "parameterName": "errorBoundary",
2268
- "parameterTypeTokenRange": {
2269
- "startIndex": 5,
2270
- "endIndex": 6
2271
- },
2272
- "isOptional": false
2273
- }
2274
- ],
2275
- "name": "showBanner"
2208
+ "name": "showBanner",
2209
+ "variableTypeTokenRange": {
2210
+ "startIndex": 1,
2211
+ "endIndex": 8
2212
+ }
2276
2213
  },
2277
2214
  {
2278
- "kind": "Function",
2279
- "canonicalReference": "@genesislcap/foundation-errors!showError:function(1)",
2215
+ "kind": "Variable",
2216
+ "canonicalReference": "@genesislcap/foundation-errors!showError:var",
2280
2217
  "docComment": "/**\n * Shows the error in the appropriate component\n *\n * @param error - The ErrorStructure object\n *\n * @param tagName - The tag name to create prefix for the design system provider *\n *\n * @param errorBoundary - The error boundary element\n *\n * @returns \n *\n * @public\n */\n",
2281
2218
  "excerptTokens": [
2282
2219
  {
2283
2220
  "kind": "Content",
2284
- "text": "showError: (error: "
2221
+ "text": "showError: "
2222
+ },
2223
+ {
2224
+ "kind": "Content",
2225
+ "text": "(error: "
2285
2226
  },
2286
2227
  {
2287
2228
  "kind": "Reference",
@@ -2308,47 +2249,17 @@
2308
2249
  },
2309
2250
  {
2310
2251
  "kind": "Content",
2311
- "text": ") => "
2312
- },
2313
- {
2314
- "kind": "Content",
2315
- "text": "void"
2252
+ "text": ") => void"
2316
2253
  }
2317
2254
  ],
2318
2255
  "fileUrlPath": "src/error-launcher.ts",
2319
- "returnTypeTokenRange": {
2320
- "startIndex": 7,
2321
- "endIndex": 8
2322
- },
2256
+ "isReadonly": true,
2323
2257
  "releaseTag": "Public",
2324
- "overloadIndex": 1,
2325
- "parameters": [
2326
- {
2327
- "parameterName": "error",
2328
- "parameterTypeTokenRange": {
2329
- "startIndex": 1,
2330
- "endIndex": 2
2331
- },
2332
- "isOptional": false
2333
- },
2334
- {
2335
- "parameterName": "tagName",
2336
- "parameterTypeTokenRange": {
2337
- "startIndex": 3,
2338
- "endIndex": 4
2339
- },
2340
- "isOptional": false
2341
- },
2342
- {
2343
- "parameterName": "errorBoundary",
2344
- "parameterTypeTokenRange": {
2345
- "startIndex": 5,
2346
- "endIndex": 6
2347
- },
2348
- "isOptional": true
2349
- }
2350
- ],
2351
- "name": "showError"
2258
+ "name": "showError",
2259
+ "variableTypeTokenRange": {
2260
+ "startIndex": 1,
2261
+ "endIndex": 8
2262
+ }
2352
2263
  },
2353
2264
  {
2354
2265
  "kind": "Interface",
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorBannerAnchor](./foundation-errors.geterrorbanneranchor.md)
4
4
 
5
- ## getErrorBannerAnchor() function
5
+ ## getErrorBannerAnchor variable
6
6
 
7
7
  Get the error banner anchor to attach the banner to
8
8
 
@@ -11,15 +11,3 @@ Get the error banner anchor to attach the banner to
11
11
  ```typescript
12
12
  getErrorBannerAnchor: (element: any) => HTMLElement | null
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | element | any | The element to start searching from |
20
-
21
- **Returns:**
22
-
23
- HTMLElement \| null
24
-
25
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md)
4
4
 
5
- ## getErrorBannerBuilder() function
5
+ ## getErrorBannerBuilder variable
6
6
 
7
7
  Get error banner builder instance
8
8
 
@@ -11,7 +11,3 @@ Get error banner builder instance
11
11
  ```typescript
12
12
  getErrorBannerBuilder: () => ErrorBannerBuilder
13
13
  ```
14
- **Returns:**
15
-
16
- [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
17
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorBuilder](./foundation-errors.geterrorbuilder.md)
4
4
 
5
- ## getErrorBuilder() function
5
+ ## getErrorBuilder variable
6
6
 
7
7
  Returns a new ErrorBuilder instance
8
8
 
@@ -11,7 +11,3 @@ Returns a new ErrorBuilder instance
11
11
  ```typescript
12
12
  getErrorBuilder: () => ErrorBuilder
13
13
  ```
14
- **Returns:**
15
-
16
- [ErrorBuilder](./foundation-errors.errorbuilder.md)
17
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorContainer](./foundation-errors.geterrorcontainer.md)
4
4
 
5
- ## getErrorContainer() function
5
+ ## getErrorContainer variable
6
6
 
7
7
  Get/Create the error container in the DOM
8
8
 
@@ -11,16 +11,3 @@ Get/Create the error container in the DOM
11
11
  ```typescript
12
12
  getErrorContainer: (id: string, tagName: String) => HTMLElement
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | id | string | The id of the container |
20
- | tagName | String | The tag name to create prefix for the design system provider |
21
-
22
- **Returns:**
23
-
24
- HTMLElement
25
-
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorDetails](./foundation-errors.geterrordetails.md)
4
4
 
5
- ## getErrorDetails() function
5
+ ## getErrorDetails variable
6
6
 
7
7
  Retrieves the error details from an ErrorStructure object
8
8
 
@@ -11,16 +11,3 @@ Retrieves the error details from an ErrorStructure object
11
11
  ```typescript
12
12
  getErrorDetails: (details: ErrorStructure) => string
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | details | [ErrorStructure](./foundation-errors.errorstructure.md) | The ErrorStructure object |
20
-
21
- **Returns:**
22
-
23
- string
24
-
25
- The title and error details concatenated as a string, or default values ('Error: Something went wrong') if not present
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md)
4
4
 
5
- ## getErrorDialogBuilder() function
5
+ ## getErrorDialogBuilder variable
6
6
 
7
7
  Returns an instance of ErrorDialogBuilder
8
8
 
@@ -11,7 +11,3 @@ Returns an instance of ErrorDialogBuilder
11
11
  ```typescript
12
12
  getErrorDialogBuilder: () => ErrorDialogBuilder
13
13
  ```
14
- **Returns:**
15
-
16
- [ErrorDialogBuilder](./foundation-errors.errordialogbuilder.md)
17
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getLoglevel](./foundation-errors.getloglevel.md)
4
4
 
5
- ## getLoglevel() function
5
+ ## getLoglevel variable
6
6
 
7
7
  Retrieves the log level from an ErrorStructure object
8
8
 
@@ -11,16 +11,3 @@ Retrieves the log level from an ErrorStructure object
11
11
  ```typescript
12
12
  getLoglevel: (details: ErrorStructure) => LogLevel
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | details | [ErrorStructure](./foundation-errors.errorstructure.md) | The ErrorStructure object |
20
-
21
- **Returns:**
22
-
23
- LogLevel
24
-
25
- The log level or the default value (LogLevel.Error) if not present
26
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md)
4
4
 
5
- ## getNotificationBuilder() function
5
+ ## getNotificationBuilder variable
6
6
 
7
7
  Get notification builder instance
8
8
 
@@ -11,7 +11,3 @@ Get notification builder instance
11
11
  ```typescript
12
12
  getNotificationBuilder: () => NotificationBuilder
13
13
  ```
14
- **Returns:**
15
-
16
- [NotificationBuilder](./foundation-errors.notificationbuilder.md)
17
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md)
4
4
 
5
- ## getSnackbarBuilder() function
5
+ ## getSnackbarBuilder variable
6
6
 
7
7
  Get snackbar builder instance
8
8
 
@@ -11,7 +11,3 @@ Get snackbar builder instance
11
11
  ```typescript
12
12
  getSnackbarBuilder: () => SnackbarBuilder
13
13
  ```
14
- **Returns:**
15
-
16
- [SnackbarBuilder](./foundation-errors.snackbarbuilder.md)
17
-
@@ -20,22 +20,6 @@
20
20
  | --- | --- |
21
21
  | [ErrorBoundaryEvent](./foundation-errors.errorboundaryevent.md) | enum for different types of error boundary events |
22
22
 
23
- ## Functions
24
-
25
- | Function | Description |
26
- | --- | --- |
27
- | [getErrorBannerAnchor(element)](./foundation-errors.geterrorbanneranchor.md) | Get the error banner anchor to attach the banner to |
28
- | [getErrorBannerBuilder()](./foundation-errors.geterrorbannerbuilder.md) | Get error banner builder instance |
29
- | [getErrorBuilder()](./foundation-errors.geterrorbuilder.md) | Returns a new ErrorBuilder instance |
30
- | [getErrorContainer(id, tagName)](./foundation-errors.geterrorcontainer.md) | Get/Create the error container in the DOM |
31
- | [getErrorDetails(details)](./foundation-errors.geterrordetails.md) | Retrieves the error details from an ErrorStructure object |
32
- | [getErrorDialogBuilder()](./foundation-errors.geterrordialogbuilder.md) | Returns an instance of ErrorDialogBuilder |
33
- | [getLoglevel(details)](./foundation-errors.getloglevel.md) | Retrieves the log level from an ErrorStructure object |
34
- | [getNotificationBuilder()](./foundation-errors.getnotificationbuilder.md) | Get notification builder instance |
35
- | [getSnackbarBuilder()](./foundation-errors.getsnackbarbuilder.md) | Get snackbar builder instance |
36
- | [showBanner(error, tagName, errorBoundary)](./foundation-errors.showbanner.md) | Shows the error dialog |
37
- | [showError(error, tagName, errorBoundary)](./foundation-errors.showerror.md) | Shows the error in the appropriate component |
38
-
39
23
  ## Interfaces
40
24
 
41
25
  | Interface | Description |
@@ -48,6 +32,22 @@
48
32
  | [ErrorStructure](./foundation-errors.errorstructure.md) | Interface for Error Structure |
49
33
  | [Snackbar](./foundation-errors.snackbar.md) | Interface for Error Snackbar configuration |
50
34
 
35
+ ## Variables
36
+
37
+ | Variable | Description |
38
+ | --- | --- |
39
+ | [getErrorBannerAnchor](./foundation-errors.geterrorbanneranchor.md) | Get the error banner anchor to attach the banner to |
40
+ | [getErrorBannerBuilder](./foundation-errors.geterrorbannerbuilder.md) | Get error banner builder instance |
41
+ | [getErrorBuilder](./foundation-errors.geterrorbuilder.md) | Returns a new ErrorBuilder instance |
42
+ | [getErrorContainer](./foundation-errors.geterrorcontainer.md) | Get/Create the error container in the DOM |
43
+ | [getErrorDetails](./foundation-errors.geterrordetails.md) | Retrieves the error details from an ErrorStructure object |
44
+ | [getErrorDialogBuilder](./foundation-errors.geterrordialogbuilder.md) | Returns an instance of ErrorDialogBuilder |
45
+ | [getLoglevel](./foundation-errors.getloglevel.md) | Retrieves the log level from an ErrorStructure object |
46
+ | [getNotificationBuilder](./foundation-errors.getnotificationbuilder.md) | Get notification builder instance |
47
+ | [getSnackbarBuilder](./foundation-errors.getsnackbarbuilder.md) | Get snackbar builder instance |
48
+ | [showBanner](./foundation-errors.showbanner.md) | Shows the error dialog |
49
+ | [showError](./foundation-errors.showerror.md) | Shows the error in the appropriate component |
50
+
51
51
  ## Type Aliases
52
52
 
53
53
  | Type Alias | Description |
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [showBanner](./foundation-errors.showbanner.md)
4
4
 
5
- ## showBanner() function
5
+ ## showBanner variable
6
6
 
7
7
  Shows the error dialog
8
8
 
@@ -11,17 +11,3 @@ Shows the error dialog
11
11
  ```typescript
12
12
  showBanner: (error: ErrorStructure, tagName: String, errorBoundary: HTMLElement) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | error | [ErrorStructure](./foundation-errors.errorstructure.md) | The ErrorStructure object |
20
- | tagName | String | The tag name to create prefix for the design system provider & error component |
21
- | errorBoundary | HTMLElement | |
22
-
23
- **Returns:**
24
-
25
- void
26
-
27
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) > [@genesislcap/foundation-errors](./foundation-errors.md) > [showError](./foundation-errors.showerror.md)
4
4
 
5
- ## showError() function
5
+ ## showError variable
6
6
 
7
7
  Shows the error in the appropriate component
8
8
 
@@ -11,17 +11,3 @@ Shows the error in the appropriate component
11
11
  ```typescript
12
12
  showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | error | [ErrorStructure](./foundation-errors.errorstructure.md) | The ErrorStructure object |
20
- | tagName | String | The tag name to create prefix for the design system provider \* |
21
- | errorBoundary | HTMLElement | _(Optional)_ The error boundary element |
22
-
23
- **Returns:**
24
-
25
- void
26
-
27
-
@@ -0,0 +1,202 @@
1
+ ## API Report File for "@genesislcap/foundation-errors"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { LogLevel } from '@genesislcap/foundation-logger';
8
+
9
+ // @public
10
+ export interface ConfirmingAction {
11
+ // (undocumented)
12
+ readonly action: Function;
13
+ // (undocumented)
14
+ readonly label: String;
15
+ }
16
+
17
+ // @public
18
+ export interface DismissingAction {
19
+ // (undocumented)
20
+ readonly action?: Function;
21
+ // (undocumented)
22
+ readonly label: String;
23
+ }
24
+
25
+ // @public
26
+ export interface ErrorBanner {
27
+ // (undocumented)
28
+ readonly confirmingActions?: Array<ConfirmingAction>;
29
+ // (undocumented)
30
+ readonly dismissingAction?: DismissingAction;
31
+ }
32
+
33
+ // @public
34
+ export class ErrorBannerBuilder {
35
+ build(): ErrorBanner;
36
+ withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
37
+ withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
38
+ }
39
+
40
+ // @public
41
+ export enum ErrorBoundaryEvent {
42
+ // (undocumented)
43
+ ERROR_BOUNDARY_EVENT = "error-boundary-event"
44
+ }
45
+
46
+ // @public
47
+ export class ErrorBuilder {
48
+ build(): ErrorStructure;
49
+ withAlert(alert: boolean): ErrorBuilder;
50
+ withBanner(banner: ErrorBanner): ErrorBuilder;
51
+ withDialog(dialog: ErrorDialog): ErrorBuilder;
52
+ withErrorDetails(errorDetails: string): ErrorBuilder;
53
+ withLogLevel(logLevel: LogLevel): ErrorBuilder;
54
+ withNotification(notification: ErrorNotification): ErrorBuilder;
55
+ withSnackbar(snackbar: Snackbar): ErrorBuilder;
56
+ withTitle(title: string): ErrorBuilder;
57
+ }
58
+
59
+ // @public
60
+ export interface ErrorDialog {
61
+ // (undocumented)
62
+ readonly confirmingActions?: Array<ConfirmingAction>;
63
+ // (undocumented)
64
+ readonly dismissingAction?: DismissingAction;
65
+ }
66
+
67
+ // @public
68
+ export class ErrorDialogBuilder {
69
+ build(): ErrorDialog;
70
+ withConfirmingAction(confirmingAction: ConfirmingAction): ErrorDialogBuilder;
71
+ withDismissingAction(dismissingAction: DismissingAction): ErrorDialogBuilder;
72
+ }
73
+
74
+ // Warning: (ae-internal-missing-underscore) The name "ErrorDialogElement" should be prefixed with an underscore because the declaration is marked as @internal
75
+ //
76
+ // @internal (undocumented)
77
+ export type ErrorDialogElement = ErrorElement & {
78
+ show: Function;
79
+ };
80
+
81
+ // Warning: (ae-internal-missing-underscore) The name "ErrorElement" should be prefixed with an underscore because the declaration is marked as @internal
82
+ //
83
+ // @internal (undocumented)
84
+ export type ErrorElement = HTMLElement & {
85
+ error: ErrorStructure;
86
+ };
87
+
88
+ // @public
89
+ export interface ErrorNotification {
90
+ // (undocumented)
91
+ readonly autoClose?: boolean;
92
+ // (undocumented)
93
+ readonly closeTimeout?: number;
94
+ // (undocumented)
95
+ readonly position?: ErrorNotificationPosition;
96
+ // (undocumented)
97
+ readonly type?: ErrorNotificationType;
98
+ }
99
+
100
+ // @public
101
+ export type ErrorNotificationPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
102
+
103
+ // @public
104
+ export type ErrorNotificationType = 'warning' | 'success';
105
+
106
+ // @public
107
+ export interface ErrorStructure {
108
+ // (undocumented)
109
+ readonly config?: {
110
+ readonly logLevel?: LogLevel;
111
+ readonly alert?: boolean;
112
+ readonly notification?: ErrorNotification;
113
+ readonly banner?: ErrorBanner;
114
+ readonly snackbar?: Snackbar;
115
+ readonly dialog?: ErrorDialog;
116
+ };
117
+ // (undocumented)
118
+ readonly errorDetails: string;
119
+ // (undocumented)
120
+ readonly logLevel?: LogLevel;
121
+ // (undocumented)
122
+ readonly title: string;
123
+ }
124
+
125
+ // @public
126
+ export const getErrorBannerAnchor: (element: any) => HTMLElement | null;
127
+
128
+ // @public
129
+ export const getErrorBannerBuilder: () => ErrorBannerBuilder;
130
+
131
+ // @public
132
+ export const getErrorBuilder: () => ErrorBuilder;
133
+
134
+ // @public
135
+ export const getErrorContainer: (id: string, tagName: String) => HTMLElement;
136
+
137
+ // @public
138
+ export const getErrorDetails: (details: ErrorStructure) => string;
139
+
140
+ // @public
141
+ export const getErrorDialogBuilder: () => ErrorDialogBuilder;
142
+
143
+ // @public
144
+ export const getLoglevel: (details: ErrorStructure) => LogLevel;
145
+
146
+ // @public
147
+ export const getNotificationBuilder: () => NotificationBuilder;
148
+
149
+ // @public
150
+ export const getSnackbarBuilder: () => SnackbarBuilder;
151
+
152
+ // @public
153
+ export class NotificationBuilder {
154
+ build(): ErrorNotification;
155
+ withAutoClose(autoClose: boolean): NotificationBuilder;
156
+ withCloseTimeout(closeTimeout: number): NotificationBuilder;
157
+ withPosition(position: ErrorNotificationPosition): NotificationBuilder;
158
+ withType(type: ErrorNotificationType): NotificationBuilder;
159
+ }
160
+
161
+ // @public
162
+ export const showBanner: (error: ErrorStructure, tagName: String, errorBoundary: HTMLElement) => void;
163
+
164
+ // Warning: (ae-internal-missing-underscore) The name "showDialog" should be prefixed with an underscore because the declaration is marked as @internal
165
+ //
166
+ // @internal
167
+ export const showDialog: (error: ErrorStructure, tagName: String) => void;
168
+
169
+ // @public
170
+ export const showError: (error: ErrorStructure, tagName: String, errorBoundary?: HTMLElement) => void;
171
+
172
+ // Warning: (ae-internal-missing-underscore) The name "showNotification" should be prefixed with an underscore because the declaration is marked as @internal
173
+ //
174
+ // @internal
175
+ export const showNotification: (error: ErrorStructure, tagName: String) => void;
176
+
177
+ // Warning: (ae-internal-missing-underscore) The name "showSnackbar" should be prefixed with an underscore because the declaration is marked as @internal
178
+ //
179
+ // @internal
180
+ export const showSnackbar: (error: ErrorStructure, tagName: String) => void;
181
+
182
+ // @public
183
+ export interface Snackbar {
184
+ // (undocumented)
185
+ readonly confirmingActions?: Array<ConfirmingAction>;
186
+ // (undocumented)
187
+ readonly type?: SnackbarType;
188
+ }
189
+
190
+ // @public
191
+ export class SnackbarBuilder {
192
+ build(): Snackbar;
193
+ withConfirmingAction(confirmingAction: ConfirmingAction): SnackbarBuilder;
194
+ withType(type: SnackbarType): SnackbarBuilder;
195
+ }
196
+
197
+ // @public
198
+ export type SnackbarType = 'error';
199
+
200
+ // (No @packageDocumentation comment for this package)
201
+
202
+ ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-errors",
3
3
  "description": "Genesis Foundation UI Error Utils",
4
- "version": "14.237.2-alpha-78ebbc0.0",
4
+ "version": "14.238.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -49,18 +49,18 @@
49
49
  }
50
50
  },
51
51
  "devDependencies": {
52
- "@genesislcap/foundation-testing": "14.237.2-alpha-78ebbc0.0",
53
- "@genesislcap/genx": "14.237.2-alpha-78ebbc0.0",
54
- "@genesislcap/rollup-builder": "14.237.2-alpha-78ebbc0.0",
55
- "@genesislcap/ts-builder": "14.237.2-alpha-78ebbc0.0",
56
- "@genesislcap/uvu-playwright-builder": "14.237.2-alpha-78ebbc0.0",
57
- "@genesislcap/vite-builder": "14.237.2-alpha-78ebbc0.0",
58
- "@genesislcap/webpack-builder": "14.237.2-alpha-78ebbc0.0",
52
+ "@genesislcap/foundation-testing": "14.238.1",
53
+ "@genesislcap/genx": "14.238.1",
54
+ "@genesislcap/rollup-builder": "14.238.1",
55
+ "@genesislcap/ts-builder": "14.238.1",
56
+ "@genesislcap/uvu-playwright-builder": "14.238.1",
57
+ "@genesislcap/vite-builder": "14.238.1",
58
+ "@genesislcap/webpack-builder": "14.238.1",
59
59
  "rimraf": "^5.0.0"
60
60
  },
61
61
  "dependencies": {
62
- "@genesislcap/foundation-logger": "14.237.2-alpha-78ebbc0.0",
63
- "tslib": "2.8.1"
62
+ "@genesislcap/foundation-logger": "14.238.1",
63
+ "tslib": "^2.3.1"
64
64
  },
65
65
  "repository": {
66
66
  "type": "git",
@@ -70,5 +70,5 @@
70
70
  "publishConfig": {
71
71
  "access": "public"
72
72
  },
73
- "gitHead": "ab5fa0da6c1d82b0d69754c35801e2b17ae7d018"
73
+ "gitHead": "c0de8cfef19e4e0e11ea5799cb7d43d7bea6ff49"
74
74
  }