npm - @genesislcap/foundation-alerts - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-alerts 14.408.0 → 14.409.0

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.

Files changed (31) hide show

package/README.md CHANGED Viewed

@@ -1,35 +1,25 @@
-# Foundation Alerts
-`foundation-alerts` is a Micro-Frontend that is used for managing a list of alert rules. It enables users to create, edit, delete, disable and view alerts rules.
-[API](./docs/api/index.md)
-`foundation-alerts` provides several exports to promote reuse and extensibility at various levels. These include but are
-not limited to:
+# @genesislcap/foundation-alerts
-* `ZeroAlerts`: A preconfigured version of the micro frontend built with the zero design system and zero components.
-* `configure`: A customisation hook for the base micro frontend that integrates it with your design system of choice.
+Documentation for this package is published on the Genesis docs site:
-## Installation
+**Docs: [Toast notifications](https://docs.genesis.global/docs/develop/client-capabilities/toast-notifications/)**
-To enable this module in your application, follow the steps below.
+## Installation
-1. Add `@genesislcap/foundation-alerts` 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-alerts": "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 CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-alerts",
   "description": "Genesis Foundation Alerts",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/foundation-alerts.d.ts",
@@ -71,20 +71,20 @@
     }
   },
   "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-comms": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-ui": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
-    "@genesislcap/foundation-zero": "14.408.0",
+    "@genesislcap/foundation-comms": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-ui": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
+    "@genesislcap/foundation-zero": "14.409.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
@@ -101,5 +101,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-alerts.alertconfig.designsystemprefix.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [AlertConfig](./foundation-alerts.alertconfig.md) &gt; [designSystemPrefix](./foundation-alerts.alertconfig.designsystemprefix.md)
-## AlertConfig.designSystemPrefix property
-Design System prefix for foundation-form
-**Signature:**
-```typescript
-designSystemPrefix: string;
-```
-## Remarks
-Used by foundation-form to specify the design system used by the form elements

package/docs/api/foundation-alerts.alertconfig.md DELETED Viewed

@@ -1,78 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [AlertConfig](./foundation-alerts.alertconfig.md)
-## AlertConfig interface
-AlertConfig DI interface.
-**Signature:**
-```typescript
-export interface AlertConfig extends PartialFASTElementDefinition
-```
-**Extends:** PartialFASTElementDefinition
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[designSystemPrefix](./foundation-alerts.alertconfig.designsystemprefix.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Design System prefix for foundation-form
-</td></tr>
-<tr><td>
-[templateOptions](./foundation-alerts.alertconfig.templateoptions.md)
-</td><td>
-</td><td>
-TemplateOptions
-</td><td>
-Template options.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-alerts.alertconfig.templateoptions.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [AlertConfig](./foundation-alerts.alertconfig.md) &gt; [templateOptions](./foundation-alerts.alertconfig.templateoptions.md)
-## AlertConfig.templateOptions property
-Template options.
-**Signature:**
-```typescript
-templateOptions: TemplateOptions;
-```
-## Remarks
-Used by host applications to assign MF template options and subcomponent tags to align with the host design system.

package/docs/api/foundation-alerts.configure.md DELETED Viewed

@@ -1,77 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [configure](./foundation-alerts.configure.md)
-## configure() function
-configure.
-**Signature:**
-```typescript
-export declare function configure(config: Partial<AlertConfig>): Promise<typeof import("../main").FoundationAlerts>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-config
-</td><td>
-Partial&lt;[AlertConfig](./foundation-alerts.alertconfig.md)<!-- -->&gt;
-</td><td>
-A partial AlertConfig.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;typeof import("../main").[FoundationAlerts](./foundation-alerts.foundationalerts.md)<!-- -->&gt;
-## Remarks
-Configure the alert micro frontend for host app integration.
-## Example
-Providing template options to align to your host application.
-```ts
-  const { configure } = await import('@genesislcap/foundation-alerts/config'); // < import from the subpath
-  return configure({
-    name: `nexus-app-alerts`,
-    // These will be merged with the packages `defaultTemplateOptions`. You will need to have these components registered in your application.
-    templateOptions: {
-      button: 'nexus-button',
-      checkbox: 'nexus-checkbox-next',
-      provider: 'template',
-    },
-  });
-},
-```

package/docs/api/foundation-alerts.defaultalertconfig.md DELETED Viewed

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [defaultAlertConfig](./foundation-alerts.defaultalertconfig.md)
-## defaultAlertConfig variable
-Default AlertConfig DI implementation.
-**Signature:**
-```typescript
-defaultAlertConfig: AlertConfig
-```

package/docs/api/foundation-alerts.foundationalerts.alertconfig.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [alertConfig](./foundation-alerts.foundationalerts.alertconfig.md)
-## FoundationAlerts.alertConfig property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-alertConfig: AlertConfig;
-```

package/docs/api/foundation-alerts.foundationalerts.alertedititemdata.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [alertEditItemData](./foundation-alerts.foundationalerts.alertedititemdata.md)
-## FoundationAlerts.alertEditItemData property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-alertEditItemData: AlertRule;
-```

package/docs/api/foundation-alerts.foundationalerts.connect.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [connect](./foundation-alerts.foundationalerts.connect.md)
-## FoundationAlerts.connect property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-connect: Connect;
-```

package/docs/api/foundation-alerts.foundationalerts.connectedcallback.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [connectedCallback](./foundation-alerts.foundationalerts.connectedcallback.md)
-## FoundationAlerts.connectedCallback() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-connectedCallback(): Promise<void>;
-```
-**Returns:**
-Promise&lt;void&gt;

package/docs/api/foundation-alerts.foundationalerts.criteriafromfilters.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [criteriaFromFilters](./foundation-alerts.foundationalerts.criteriafromfilters.md)
-## FoundationAlerts.criteriaFromFilters property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-criteriaFromFilters: Map<string, string>;
-```

package/docs/api/foundation-alerts.foundationalerts.criteriafromfilterschanged.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [criteriaFromFiltersChanged](./foundation-alerts.foundationalerts.criteriafromfilterschanged.md)
-## FoundationAlerts.criteriaFromFiltersChanged() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-criteriaFromFiltersChanged(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-alerts.foundationalerts.datasource.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [datasource](./foundation-alerts.foundationalerts.datasource.md)
-## FoundationAlerts.datasource property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-datasource: Datasource;
-```

package/docs/api/foundation-alerts.foundationalerts.datasubscription.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [dataSubscription](./foundation-alerts.foundationalerts.datasubscription.md)
-## FoundationAlerts.dataSubscription property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-dataSubscription: Subscription;
-```

package/docs/api/foundation-alerts.foundationalerts.delete.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [delete](./foundation-alerts.foundationalerts.delete.md)
-## FoundationAlerts.delete() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-delete(id: AlertRuleRow['DYNAMIC_NOTIFY_RULE_ID']): Promise<Message>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-id
-</td><td>
-AlertRuleRow\['DYNAMIC\_NOTIFY\_RULE\_ID'\]
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Message&gt;

package/docs/api/foundation-alerts.foundationalerts.disconnectedcallback.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [disconnectedCallback](./foundation-alerts.foundationalerts.disconnectedcallback.md)
-## FoundationAlerts.disconnectedCallback() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-disconnectedCallback(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-alerts.foundationalerts.displaystate.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [displayState](./foundation-alerts.foundationalerts.displaystate.md)
-## FoundationAlerts.displayState property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-displayState: displayState;
-```

package/docs/api/foundation-alerts.foundationalerts.filters.md DELETED Viewed

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [filters](./foundation-alerts.foundationalerts.filters.md)
-## FoundationAlerts.filters property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-filters: {
-        name: string;
-        callback: () => void;
-        icon: {
-            name: string;
-        };
-    }[];
-```

package/docs/api/foundation-alerts.foundationalerts.handleaddalertaction.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [handleAddAlertAction](./foundation-alerts.foundationalerts.handleaddalertaction.md)
-## FoundationAlerts.handleAddAlertAction() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-handleAddAlertAction(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-alerts.foundationalerts.handleeditalertaction.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [handleEditAlertAction](./foundation-alerts.foundationalerts.handleeditalertaction.md)
-## FoundationAlerts.handleEditAlertAction() method
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-handleEditAlertAction(item: any): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-item
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-alerts.foundationalerts.items.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [items](./foundation-alerts.foundationalerts.items.md)
-## FoundationAlerts.items property
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-items: AlertRule[];
-```