@genesislcap/foundation-errors 10.3.1 → 11.3.1

package/dist/foundation-errors.api.json

@@ -175,7 +175,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!ConfirmingAction:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Confirming Action configuration\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -249,7 +249,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!DismissingAction:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Dismissing Action configuration\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -323,7 +323,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorBanner:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Error Banner configuration\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -410,7 +410,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorBannerBuilder:class",
-          "docComment": "",
+          "docComment": "/**\n * ErrorBannerBuilder to build ErrorBanner\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -426,7 +426,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBannerBuilder#build:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Build ErrorBanner\n *\n * @returns ErrorBanner\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -458,7 +458,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBannerBuilder#withConfirmingAction:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add confirming action to ErrorBanner\n *\n * @param confirmingAction - {@link ConfirmingAction}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -508,7 +508,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBannerBuilder#withDismissingAction:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add dismissing action to ErrorBanner\n *\n * @param dismissingAction - {@link DismissingAction}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -561,7 +561,7 @@
         {
           "kind": "Enum",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorBoundaryEvent:enum",
-          "docComment": "",
+          "docComment": "/**\n * enum for different types of error boundary events\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -599,7 +599,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder:class",
-          "docComment": "",
+          "docComment": "/**\n * ErrorBuilder to build ErrorStructure\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -615,7 +615,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#build:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Build ErrorStructure\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -647,7 +647,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withAlert:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add alert to error\n *\n * @param alert - boolean\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -696,7 +696,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withBanner:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add banner to error\n *\n * @param banner - {@link ErrorBanner}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -746,7 +746,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withDialog:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add dialog to error\n *\n * @param dialog - {@link ErrorDialog}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -796,7 +796,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withErrorDetails:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add error details to error\n *\n * @param errorDetails - string\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -845,7 +845,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withLogLevel:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add log level to error\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -895,7 +895,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withNotification:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add notification to error\n *\n * @param notification - {@link ErrorNotification}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -945,7 +945,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withSnackbar:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add snackbar to error\n *\n * @param snackbar - {@link Snackbar}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -995,7 +995,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorBuilder#withTitle:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add title to error\n *\n * @param title - string\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1047,7 +1047,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorDialog:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Error Dialog configuration\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1134,7 +1134,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorDialogBuilder:class",
-          "docComment": "",
+          "docComment": "/**\n * ErrorDialogBuilder class\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1150,7 +1150,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorDialogBuilder#build:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Build ErrorDialog\n *\n * @returns ErrorDialog\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1182,7 +1182,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorDialogBuilder#withConfirmingAction:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add confirming action to ErrorDialog\n *\n * @param confirmingAction - {@link ConfirmingAction}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1232,7 +1232,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!ErrorDialogBuilder#withDismissingAction:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add dismissing action to ErrorDialog\n *\n * @param dismissingAction - {@link DismissingAction}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1282,90 +1282,10 @@
           ],
           "implementsTokenRanges": []
         },
-        {
-          "kind": "TypeAlias",
-          "canonicalReference": "@genesislcap/foundation-errors!ErrorDialogElement:type",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export type ErrorDialogElement = "
-            },
-            {
-              "kind": "Reference",
-              "text": "ErrorElement",
-              "canonicalReference": "@genesislcap/foundation-errors!ErrorElement:type"
-            },
-            {
-              "kind": "Content",
-              "text": " & {\n    show: "
-            },
-            {
-              "kind": "Reference",
-              "text": "Function",
-              "canonicalReference": "!Function:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ";\n}"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/types.ts",
-          "releaseTag": "Public",
-          "name": "ErrorDialogElement",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 5
-          }
-        },
-        {
-          "kind": "TypeAlias",
-          "canonicalReference": "@genesislcap/foundation-errors!ErrorElement:type",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export type ErrorElement = "
-            },
-            {
-              "kind": "Reference",
-              "text": "HTMLElement",
-              "canonicalReference": "!HTMLElement:interface"
-            },
-            {
-              "kind": "Content",
-              "text": " & {\n    error: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ErrorStructure",
-              "canonicalReference": "@genesislcap/foundation-errors!ErrorStructure:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ";\n}"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/types.ts",
-          "releaseTag": "Public",
-          "name": "ErrorElement",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 5
-          }
-        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorNotification:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Error Notification configuration\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1441,8 +1361,9 @@
                   "text": "readonly type?: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "'warning' | 'success' | ''"
+                  "kind": "Reference",
+                  "text": "ErrorNotificationType",
+                  "canonicalReference": "@genesislcap/foundation-errors!ErrorNotificationType:type"
                 },
                 {
                   "kind": "Content",
@@ -1461,10 +1382,36 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-errors!ErrorNotificationType:type",
+          "docComment": "/**\n * type for error notification type\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ErrorNotificationType = "
+            },
+            {
+              "kind": "Content",
+              "text": "'warning' | 'success'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "ErrorNotificationType",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!ErrorStructure:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Error Structure\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1636,7 +1583,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!getErrorBannerBuilder:var",
-          "docComment": "",
+          "docComment": "/**\n * Get error banner builder instance\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1664,7 +1611,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!getErrorBuilder:var",
-          "docComment": "",
+          "docComment": "/**\n * Returns a new ErrorBuilder instance\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1761,7 +1708,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!getErrorDialogBuilder:var",
-          "docComment": "",
+          "docComment": "/**\n * Returns an instance of ErrorDialogBuilder\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1826,7 +1773,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!getNotificationBuilder:var",
-          "docComment": "",
+          "docComment": "/**\n * Get notification builder instance\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1854,7 +1801,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!getSnackbarBuilder:var",
-          "docComment": "",
+          "docComment": "/**\n * Get snackbar builder instance\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1882,7 +1829,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-errors!NotificationBuilder:class",
-          "docComment": "",
+          "docComment": "/**\n * NotificationBuilder to build ErrorNotification\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1898,7 +1845,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!NotificationBuilder#build:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Build notification\n *\n * @returns ErrorNotification\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1930,7 +1877,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!NotificationBuilder#withAutoClose:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add auto close to notification\n *\n * @param autoClose - boolean\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1979,7 +1926,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!NotificationBuilder#withCloseTimeout:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add close timeout to notification\n *\n * @param closeTimeout - number\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2028,15 +1975,16 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!NotificationBuilder#withType:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Add type to notification, if the type is anything other than 'warning' or 'success' do not add it\n *\n * @param type - {@link ErrorNotificationType}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
                   "text": "withType(type: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "'warning' | 'success' | ''"
+                  "kind": "Reference",
+                  "text": "ErrorNotificationType",
+                  "canonicalReference": "@genesislcap/foundation-errors!ErrorNotificationType:type"
                 },
                 {
                   "kind": "Content",
@@ -2077,47 +2025,6 @@
           ],
           "implementsTokenRanges": []
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-errors!showDialog:var",
-          "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",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "showDialog: "
-            },
-            {
-              "kind": "Content",
-              "text": "(error: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ErrorStructure",
-              "canonicalReference": "@genesislcap/foundation-errors!ErrorStructure:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", tagName: "
-            },
-            {
-              "kind": "Reference",
-              "text": "String",
-              "canonicalReference": "!String:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ") => void"
-            }
-          ],
-          "fileUrlPath": "src/dialog/error-dialog-launcher.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "showDialog",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 6
-          }
-        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-errors!showError:var",
@@ -2159,92 +2066,10 @@
             "endIndex": 6
           }
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-errors!showNotification:var",
-          "docComment": "/**\n * Shows the error notification\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",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "showNotification: "
-            },
-            {
-              "kind": "Content",
-              "text": "(error: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ErrorStructure",
-              "canonicalReference": "@genesislcap/foundation-errors!ErrorStructure:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", tagName: "
-            },
-            {
-              "kind": "Reference",
-              "text": "String",
-              "canonicalReference": "!String:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ") => void"
-            }
-          ],
-          "fileUrlPath": "src/notification/notification-launcher.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "showNotification",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 6
-          }
-        },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-errors!showSnackbar:var",
-          "docComment": "/**\n * Shows the snackbar\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",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "showSnackbar: "
-            },
-            {
-              "kind": "Content",
-              "text": "(error: "
-            },
-            {
-              "kind": "Reference",
-              "text": "ErrorStructure",
-              "canonicalReference": "@genesislcap/foundation-errors!ErrorStructure:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ", tagName: "
-            },
-            {
-              "kind": "Reference",
-              "text": "String",
-              "canonicalReference": "!String:interface"
-            },
-            {
-              "kind": "Content",
-              "text": ") => void"
-            }
-          ],
-          "fileUrlPath": "src/snackbar/snackbar-launcher.ts",
-          "isReadonly": true,
-          "releaseTag": "Public",
-          "name": "showSnackbar",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 6
-          }
-        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-errors!Snackbar:interface",
-          "docComment": "",
+          "docComment": "/**\n * Interface for Error Snackbar configuration\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2307,8 +2132,9 @@
                   "text": "readonly type?: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "'error' | ''"
+                  "kind": "Reference",
+                  "text": "SnackbarType",
+                  "canonicalReference": "@genesislcap/foundation-errors!SnackbarType:type"
                 },
                 {
                   "kind": "Content",
@@ -2330,7 +2156,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-errors!SnackbarBuilder:class",
-          "docComment": "",
+          "docComment": "/**\n * SnackbarBuilder to build Snackbar\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2378,7 +2204,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!SnackbarBuilder#withConfirmingAction:member(1)",
-              "docComment": "/**\n * Add confirming action to snackbar\n *\n * @param confirmingAction - \n *\n * @returns \n *\n * @public\n */\n",
+              "docComment": "/**\n * Add confirming action to snackbar\n *\n * @param confirmingAction - {@link ConfirmingAction}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2428,15 +2254,16 @@
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-errors!SnackbarBuilder#withType:member(1)",
-              "docComment": "/**\n * Add type to snackbar\n *\n * @param type - \n *\n * @returns \n *\n * @public\n */\n",
+              "docComment": "/**\n * Add type to snackbar, if the type is anything other than 'error' do not add it\n *\n * @param type - {@link SnackbarType}\n *\n * @returns \n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
                   "text": "withType(type: "
                 },
                 {
-                  "kind": "Content",
-                  "text": "'error' | ''"
+                  "kind": "Reference",
+                  "text": "SnackbarType",
+                  "canonicalReference": "@genesislcap/foundation-errors!SnackbarType:type"
                 },
                 {
                   "kind": "Content",
@@ -2476,6 +2303,32 @@
             }
           ],
           "implementsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-errors!SnackbarType:type",
+          "docComment": "/**\n * type for snackbar type\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type SnackbarType = "
+            },
+            {
+              "kind": "Content",
+              "text": "'error'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "SnackbarType",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
         }
       ]
     }