@genesislcap/foundation-errors 14.408.0 → 14.409.0

package/README.md

@@ -1,67 +1,25 @@
-# Genesis Foundation UI Error Utils
+# @genesislcap/foundation-errors
 
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+Documentation for this package is published on the Genesis docs site:
 
-### Usage
-
-* The App need to create Error boundary component at top of the component tree.
-
-* Any child under Error boundary component can dispatch custom Error event
-
-* The custom event is handled by Error boundary component and based on event payload
-  it displays error on different Error component
-
-### Current Implementation support following Error Components
-
-* Alert
-* Toast
-* Banner
-* Snack bar
-* Dialog
-
-### Creating and dispatching Error Events
-
-Creating and dispatching Error event with payload to show in Toast/Notification component
-
-```javascript
-$emit(
-  ErrorBoundaryEvent.ERROR_BOUNDARY_EVENT,
-  getErrorBuilder()
-    .withTitle(err.CODE)
-    .withErrorDetails(getErrorFormat(err))
-    .withNotification(
-      getNotificationBuilder()
-        .withType('warning')
-        .withAutoClose(true)
-        .withCloseTimeout(notificationCloseTimeout)
-        .build())
-    .build())
-```
+**Docs: [Utility methods](https://docs.genesis.global/docs/develop/client-capabilities/utility-methods/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-errors` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-errors": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
 
-## [API Docs](./docs/api/index.md)
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-errors",
   "description": "Genesis Foundation UI Error Utils",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -51,16 +51,16 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.408.0"
+    "@genesislcap/foundation-logger": "14.409.0"
   },
   "repository": {
     "type": "git",
@@ -70,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-errors.confirmingaction.action.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ConfirmingAction](./foundation-errors.confirmingaction.md) &gt; [action](./foundation-errors.confirmingaction.action.md)
-
-## ConfirmingAction.action property
-
-**Signature:**
-
-```typescript
-readonly action: Function;
-```

package/docs/api/foundation-errors.confirmingaction.label.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ConfirmingAction](./foundation-errors.confirmingaction.md) &gt; [label](./foundation-errors.confirmingaction.label.md)
-
-## ConfirmingAction.label property
-
-**Signature:**
-
-```typescript
-readonly label: String;
-```

package/docs/api/foundation-errors.confirmingaction.md

@@ -1,77 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ConfirmingAction](./foundation-errors.confirmingaction.md)
-
-## ConfirmingAction interface
-
-Interface for Confirming Action configuration
-
-**Signature:**
-
-```typescript
-export interface ConfirmingAction 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[action](./foundation-errors.confirmingaction.action.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[label](./foundation-errors.confirmingaction.label.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-String
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.dismissingaction.action.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [DismissingAction](./foundation-errors.dismissingaction.md) &gt; [action](./foundation-errors.dismissingaction.action.md)
-
-## DismissingAction.action property
-
-**Signature:**
-
-```typescript
-readonly action?: Function;
-```

package/docs/api/foundation-errors.dismissingaction.label.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [DismissingAction](./foundation-errors.dismissingaction.md) &gt; [label](./foundation-errors.dismissingaction.label.md)
-
-## DismissingAction.label property
-
-**Signature:**
-
-```typescript
-readonly label: String;
-```

package/docs/api/foundation-errors.dismissingaction.md

@@ -1,79 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [DismissingAction](./foundation-errors.dismissingaction.md)
-
-## DismissingAction interface
-
-Interface for Dismissing Action configuration
-
-**Signature:**
-
-```typescript
-export interface DismissingAction 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[action?](./foundation-errors.dismissingaction.action.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[label](./foundation-errors.dismissingaction.label.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-String
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.errorbanner.confirmingactions.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBanner](./foundation-errors.errorbanner.md) &gt; [confirmingActions](./foundation-errors.errorbanner.confirmingactions.md)
-
-## ErrorBanner.confirmingActions property
-
-**Signature:**
-
-```typescript
-readonly confirmingActions?: Array<ConfirmingAction>;
-```

package/docs/api/foundation-errors.errorbanner.dismissingaction.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBanner](./foundation-errors.errorbanner.md) &gt; [dismissingAction](./foundation-errors.errorbanner.dismissingaction.md)
-
-## ErrorBanner.dismissingAction property
-
-**Signature:**
-
-```typescript
-readonly dismissingAction?: DismissingAction;
-```

package/docs/api/foundation-errors.errorbanner.md

@@ -1,81 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBanner](./foundation-errors.errorbanner.md)
-
-## ErrorBanner interface
-
-Interface for Error Banner configuration
-
-**Signature:**
-
-```typescript
-export interface ErrorBanner 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[confirmingActions?](./foundation-errors.errorbanner.confirmingactions.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Array&lt;[ConfirmingAction](./foundation-errors.confirmingaction.md)<!-- -->&gt;
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[dismissingAction?](./foundation-errors.errorbanner.dismissingaction.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[DismissingAction](./foundation-errors.dismissingaction.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.errorbannerbuilder.build.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md) &gt; [build](./foundation-errors.errorbannerbuilder.build.md)
-
-## ErrorBannerBuilder.build() method
-
-Build ErrorBanner
-
-**Signature:**
-
-```typescript
-build(): ErrorBanner;
-```
-**Returns:**
-
-[ErrorBanner](./foundation-errors.errorbanner.md)
-
-ErrorBanner
-

package/docs/api/foundation-errors.errorbannerbuilder.md

@@ -1,76 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
-
-## ErrorBannerBuilder class
-
-ErrorBannerBuilder to build ErrorBanner
-
-**Signature:**
-
-```typescript
-export declare class ErrorBannerBuilder 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[build()](./foundation-errors.errorbannerbuilder.build.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Build ErrorBanner
-
-
-</td></tr>
-<tr><td>
-
-[withConfirmingAction(confirmingAction)](./foundation-errors.errorbannerbuilder.withconfirmingaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add confirming action to ErrorBanner
-
-
-</td></tr>
-<tr><td>
-
-[withDismissingAction(dismissingAction)](./foundation-errors.errorbannerbuilder.withdismissingaction.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Add dismissing action to ErrorBanner
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-errors.errorbannerbuilder.withconfirmingaction.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md) &gt; [withConfirmingAction](./foundation-errors.errorbannerbuilder.withconfirmingaction.md)
-
-## ErrorBannerBuilder.withConfirmingAction() method
-
-Add confirming action to ErrorBanner
-
-**Signature:**
-
-```typescript
-withConfirmingAction(confirmingAction: ConfirmingAction): ErrorBannerBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-confirmingAction
-
-
-</td><td>
-
-[ConfirmingAction](./foundation-errors.confirmingaction.md)
-
-
-</td><td>
-
-[ConfirmingAction](./foundation-errors.confirmingaction.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
-
-

package/docs/api/foundation-errors.errorbannerbuilder.withdismissingaction.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md) &gt; [withDismissingAction](./foundation-errors.errorbannerbuilder.withdismissingaction.md)
-
-## ErrorBannerBuilder.withDismissingAction() method
-
-Add dismissing action to ErrorBanner
-
-**Signature:**
-
-```typescript
-withDismissingAction(dismissingAction: DismissingAction): ErrorBannerBuilder;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dismissingAction
-
-
-</td><td>
-
-[DismissingAction](./foundation-errors.dismissingaction.md)
-
-
-</td><td>
-
-[DismissingAction](./foundation-errors.dismissingaction.md)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[ErrorBannerBuilder](./foundation-errors.errorbannerbuilder.md)
-
-

package/docs/api/foundation-errors.errorboundaryevent.md

@@ -1,48 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-errors](./foundation-errors.md) &gt; [ErrorBoundaryEvent](./foundation-errors.errorboundaryevent.md)
-
-## ErrorBoundaryEvent enum
-
-enum for different types of error boundary events
-
-**Signature:**
-
-```typescript
-export declare enum ErrorBoundaryEvent 
-```
-
-## Enumeration Members
-
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-ERROR\_BOUNDARY\_EVENT
-
-
-</td><td>
-
-`"error-boundary-event"`
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-