@genesislcap/foundation-alerts 14.184.0 → 14.185.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 (36) hide show
  1. package/dist/dts/main/main.d.ts +1 -1
  2. package/dist/dts/main/main.d.ts.map +1 -1
  3. package/dist/dts/main/main.template.d.ts +1 -1
  4. package/dist/dts/main/main.template.d.ts.map +1 -1
  5. package/dist/esm/main/main.js +1 -1
  6. package/docs/.gitattributes +2 -0
  7. package/docs/api/foundation-alerts.alertconfig.designsystemprefix.md +18 -0
  8. package/docs/api/foundation-alerts.alertconfig.md +22 -0
  9. package/docs/api/foundation-alerts.alertconfig.templateoptions.md +18 -0
  10. package/docs/api/foundation-alerts.configure.md +47 -0
  11. package/docs/api/foundation-alerts.defaultalertconfig.md +13 -0
  12. package/docs/api/foundation-alerts.foundationalerts.alertconfig.md +14 -0
  13. package/docs/api/foundation-alerts.foundationalerts.alertedititemdata.md +14 -0
  14. package/docs/api/foundation-alerts.foundationalerts.connect.md +14 -0
  15. package/docs/api/foundation-alerts.foundationalerts.connectedcallback.md +18 -0
  16. package/docs/api/foundation-alerts.foundationalerts.criteriafromfilters.md +14 -0
  17. package/docs/api/foundation-alerts.foundationalerts.criteriafromfilterschanged.md +18 -0
  18. package/docs/api/foundation-alerts.foundationalerts.datasource.md +14 -0
  19. package/docs/api/foundation-alerts.foundationalerts.datasubscription.md +14 -0
  20. package/docs/api/foundation-alerts.foundationalerts.delete.md +25 -0
  21. package/docs/api/foundation-alerts.foundationalerts.disconnectedcallback.md +18 -0
  22. package/docs/api/foundation-alerts.foundationalerts.displaystate.md +14 -0
  23. package/docs/api/foundation-alerts.foundationalerts.filters.md +20 -0
  24. package/docs/api/foundation-alerts.foundationalerts.handleaddalertaction.md +18 -0
  25. package/docs/api/foundation-alerts.foundationalerts.handleeditalertaction.md +25 -0
  26. package/docs/api/foundation-alerts.foundationalerts.items.md +14 -0
  27. package/docs/api/foundation-alerts.foundationalerts.md +45 -0
  28. package/docs/api/foundation-alerts.foundationalerts.ready.md +14 -0
  29. package/docs/api/foundation-alerts.foundationalerts.tooglestatus.md +25 -0
  30. package/docs/api/foundation-alerts.foundationalertsstyles.md +12 -0
  31. package/docs/api/foundation-alerts.foundationalertstemplate.md +12 -0
  32. package/docs/api/foundation-alerts.md +33 -0
  33. package/docs/api/foundation-alerts.zeroalerts.md +39 -0
  34. package/docs/api/index.md +12 -0
  35. package/docs/api-report.md +109 -0
  36. package/package.json +23 -15
@@ -1,7 +1,7 @@
1
1
  import { Connect, Datasource, Message } from '@genesislcap/foundation-comms';
2
2
  import { FASTElement } from '@microsoft/fast-element';
3
3
  import { Subscription } from 'rxjs';
4
- import { AlertConfig } from '../config';
4
+ import { AlertConfig } from '../config/config';
5
5
  import { AlertRule, AlertRuleRow } from './main.types';
6
6
  type displayState = 'add' | 'edit' | 'list';
7
7
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,UAAU,EACV,OAAO,EAKR,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAiB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAIxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEvD,KAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5C;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IACtC,OAAO,EAAE,OAAO,CAAC;IACd,UAAU,EAAG,UAAU,CAAC;IACxB,YAAY,EAAE,YAAY,CAAU;IACpC,KAAK,EAAE,SAAS,EAAE,CAAM;IACxB,iBAAiB,EAAE,SAAS,CAAC;IAC5B,WAAW,EAAG,WAAW,CAAC;IAEvC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,cAAc,CAGpB;IACK,gBAAgB,EAAE,YAAY,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAS;IACvB,OAAO;;;;;;QA4BZ;IACU,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAa;IACjE,0BAA0B;IAMpB,iBAAiB;IAQvB,oBAAoB;IAWpB,OAAO,CAAC,mBAAmB;YAIb,SAAS;IAyCvB,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,YAAY;IAKP,MAAM,CAAC,EAAE,EAAE,YAAY,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpE,YAAY,CAAC,EACxB,WAAW,EACX,sBAAsB,EAAE,EAAE,GAC3B,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAO3B,oBAAoB;IAIpB,qBAAqB,CAAC,IAAI,EAAE,GAAG;CAQvC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAKa,UAAW,SAAQ,gBAAgB;IAC9C;;OAEG;IACG,iBAAiB;IAKvB;;OAEG;cACa,WAAW;CAI5B"}
1
+ {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,UAAU,EACV,OAAO,EAKR,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAiB,WAAW,EAAc,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAI/C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEvD,KAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5C;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IACtC,OAAO,EAAE,OAAO,CAAC;IACd,UAAU,EAAG,UAAU,CAAC;IACxB,YAAY,EAAE,YAAY,CAAU;IACpC,KAAK,EAAE,SAAS,EAAE,CAAM;IACxB,iBAAiB,EAAE,SAAS,CAAC;IAC5B,WAAW,EAAG,WAAW,CAAC;IAEvC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,cAAc,CAGpB;IACK,gBAAgB,EAAE,YAAY,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAS;IACvB,OAAO;;;;;;QA4BZ;IACU,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAa;IACjE,0BAA0B;IAMpB,iBAAiB;IAQvB,oBAAoB;IAWpB,OAAO,CAAC,mBAAmB;YAIb,SAAS;IAyCvB,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,aAAa;IAerB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,YAAY;IAKP,MAAM,CAAC,EAAE,EAAE,YAAY,CAAC,wBAAwB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpE,YAAY,CAAC,EACxB,WAAW,EACX,sBAAsB,EAAE,EAAE,GAC3B,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAO3B,oBAAoB;IAIpB,qBAAqB,CAAC,IAAI,EAAE,GAAG;CAQvC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAKa,UAAW,SAAQ,gBAAgB;IAC9C;;OAEG;IACG,iBAAiB;IAKvB;;OAEG;cACa,WAAW;CAI5B"}
@@ -1,4 +1,4 @@
1
- import { FoundationAlerts } from './main';
1
+ import type { FoundationAlerts } from './main';
2
2
  /**
3
3
  * @public
4
4
  */
@@ -1 +1 @@
1
- {"version":3,"file":"main.template.d.ts","sourceRoot":"","sources":["../../../src/main/main.template.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C;;GAEG;AACH,eAAO,MAAM,wBAAwB,uEA8FpC,CAAC"}
1
+ {"version":3,"file":"main.template.d.ts","sourceRoot":"","sources":["../../../src/main/main.template.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG/C;;GAEG;AACH,eAAO,MAAM,wBAAwB,uEA8FpC,CAAC"}
@@ -1,7 +1,7 @@
1
1
  import { __awaiter, __decorate } from "tslib";
2
2
  import { Connect, Datasource, normaliseCriteria, dataServerResultFilter, MessageType, } from '@genesislcap/foundation-comms';
3
3
  import { customElement, FASTElement, observable } from '@microsoft/fast-element';
4
- import { AlertConfig } from '../config';
4
+ import { AlertConfig } from '../config/config';
5
5
  import { FoundationAlertsStyles as styles } from '../styles';
6
6
  import { logger } from '../utils';
7
7
  import { FoundationAlertsTemplate as template } from './main.template';
@@ -0,0 +1,2 @@
1
+ *.md -diff
2
+ *.md linguist-generated
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [AlertConfig](./foundation-alerts.alertconfig.md) &gt; [designSystemPrefix](./foundation-alerts.alertconfig.designsystemprefix.md)
4
+
5
+ ## AlertConfig.designSystemPrefix property
6
+
7
+ Design System prefix for foundation-form
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ designSystemPrefix: string;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Used by foundation-form to specify the design system used by the form elements
18
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [AlertConfig](./foundation-alerts.alertconfig.md)
4
+
5
+ ## AlertConfig interface
6
+
7
+ AlertConfig DI interface.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface AlertConfig extends PartialFASTElementDefinition
13
+ ```
14
+ **Extends:** PartialFASTElementDefinition
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [designSystemPrefix](./foundation-alerts.alertconfig.designsystemprefix.md) | | string | Design System prefix for foundation-form |
21
+ | [templateOptions](./foundation-alerts.alertconfig.templateoptions.md) | | TemplateOptions | Template options. |
22
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [AlertConfig](./foundation-alerts.alertconfig.md) &gt; [templateOptions](./foundation-alerts.alertconfig.templateoptions.md)
4
+
5
+ ## AlertConfig.templateOptions property
6
+
7
+ Template options.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ templateOptions: TemplateOptions;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Used by host applications to assign MF template options and subcomponent tags to align with the host design system.
18
+
@@ -0,0 +1,47 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [configure](./foundation-alerts.configure.md)
4
+
5
+ ## configure() function
6
+
7
+ configure.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare function configure(config: Partial<AlertConfig>): Promise<typeof import("../main").FoundationAlerts>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | config | Partial&lt;[AlertConfig](./foundation-alerts.alertconfig.md)<!-- -->&gt; | A partial AlertConfig. |
20
+
21
+ **Returns:**
22
+
23
+ Promise&lt;typeof import("../main").[FoundationAlerts](./foundation-alerts.foundationalerts.md)<!-- -->&gt;
24
+
25
+ ## Remarks
26
+
27
+ Configure the alert micro frontend for host app integration.
28
+
29
+ ## Example
30
+
31
+ Providing template options to align to your host application.
32
+
33
+ ```ts
34
+
35
+ const { configure } = await import('@genesislcap/foundation-alerts/config'); // < import from the subpath
36
+ return configure({
37
+ name: `nexus-app-alerts`,
38
+ // These will be merged with the packages `defaultTemplateOptions`. You will need to have these components registered in your application.
39
+ templateOptions: {
40
+ button: 'nexus-button',
41
+ checkbox: 'nexus-checkbox-next',
42
+ provider: 'template',
43
+ },
44
+ });
45
+ },
46
+ ```
47
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [defaultAlertConfig](./foundation-alerts.defaultalertconfig.md)
4
+
5
+ ## defaultAlertConfig variable
6
+
7
+ Default AlertConfig DI implementation.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ defaultAlertConfig: AlertConfig
13
+ ```
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [alertConfig](./foundation-alerts.foundationalerts.alertconfig.md)
4
+
5
+ ## FoundationAlerts.alertConfig property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ alertConfig: AlertConfig;
14
+ ```
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [alertEditItemData](./foundation-alerts.foundationalerts.alertedititemdata.md)
4
+
5
+ ## FoundationAlerts.alertEditItemData property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ alertEditItemData: AlertRule;
14
+ ```
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [connect](./foundation-alerts.foundationalerts.connect.md)
4
+
5
+ ## FoundationAlerts.connect property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ connect: Connect;
14
+ ```
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [connectedCallback](./foundation-alerts.foundationalerts.connectedcallback.md)
4
+
5
+ ## FoundationAlerts.connectedCallback() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ connectedCallback(): Promise<void>;
14
+ ```
15
+ **Returns:**
16
+
17
+ Promise&lt;void&gt;
18
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [criteriaFromFilters](./foundation-alerts.foundationalerts.criteriafromfilters.md)
4
+
5
+ ## FoundationAlerts.criteriaFromFilters property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ criteriaFromFilters: Map<string, string>;
14
+ ```
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [criteriaFromFiltersChanged](./foundation-alerts.foundationalerts.criteriafromfilterschanged.md)
4
+
5
+ ## FoundationAlerts.criteriaFromFiltersChanged() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ criteriaFromFiltersChanged(): void;
14
+ ```
15
+ **Returns:**
16
+
17
+ void
18
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [datasource](./foundation-alerts.foundationalerts.datasource.md)
4
+
5
+ ## FoundationAlerts.datasource property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ datasource: Datasource;
14
+ ```
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [dataSubscription](./foundation-alerts.foundationalerts.datasubscription.md)
4
+
5
+ ## FoundationAlerts.dataSubscription property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ dataSubscription: Subscription;
14
+ ```
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [delete](./foundation-alerts.foundationalerts.delete.md)
4
+
5
+ ## FoundationAlerts.delete() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ delete(id: AlertRuleRow['DYNAMIC_NOTIFY_RULE_ID']): Promise<Message>;
14
+ ```
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | --- | --- | --- |
20
+ | id | AlertRuleRow\['DYNAMIC\_NOTIFY\_RULE\_ID'\] | |
21
+
22
+ **Returns:**
23
+
24
+ Promise&lt;Message&gt;
25
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [disconnectedCallback](./foundation-alerts.foundationalerts.disconnectedcallback.md)
4
+
5
+ ## FoundationAlerts.disconnectedCallback() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ disconnectedCallback(): void;
14
+ ```
15
+ **Returns:**
16
+
17
+ void
18
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [displayState](./foundation-alerts.foundationalerts.displaystate.md)
4
+
5
+ ## FoundationAlerts.displayState property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ displayState: displayState;
14
+ ```
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [filters](./foundation-alerts.foundationalerts.filters.md)
4
+
5
+ ## FoundationAlerts.filters property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ filters: {
14
+ name: string;
15
+ callback: () => void;
16
+ icon: {
17
+ name: string;
18
+ };
19
+ }[];
20
+ ```
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [handleAddAlertAction](./foundation-alerts.foundationalerts.handleaddalertaction.md)
4
+
5
+ ## FoundationAlerts.handleAddAlertAction() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ handleAddAlertAction(): void;
14
+ ```
15
+ **Returns:**
16
+
17
+ void
18
+
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [handleEditAlertAction](./foundation-alerts.foundationalerts.handleeditalertaction.md)
4
+
5
+ ## FoundationAlerts.handleEditAlertAction() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ handleEditAlertAction(item: any): void;
14
+ ```
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | --- | --- | --- |
20
+ | item | any | |
21
+
22
+ **Returns:**
23
+
24
+ void
25
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [items](./foundation-alerts.foundationalerts.items.md)
4
+
5
+ ## FoundationAlerts.items property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ items: AlertRule[];
14
+ ```
@@ -0,0 +1,45 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md)
4
+
5
+ ## FoundationAlerts class
6
+
7
+ > 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.
8
+ >
9
+
10
+ Foundation alerts component for handle alerts rules list Allow creating, disabling and deleting alerts
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare class FoundationAlerts extends FASTElement
16
+ ```
17
+ **Extends:** FASTElement
18
+
19
+ ## Properties
20
+
21
+ | Property | Modifiers | Type | Description |
22
+ | --- | --- | --- | --- |
23
+ | [alertConfig](./foundation-alerts.foundationalerts.alertconfig.md) | | [AlertConfig](./foundation-alerts.alertconfig.md) | **_(BETA)_** |
24
+ | [alertEditItemData](./foundation-alerts.foundationalerts.alertedititemdata.md) | | AlertRule | **_(BETA)_** |
25
+ | [connect](./foundation-alerts.foundationalerts.connect.md) | | Connect | **_(BETA)_** |
26
+ | [criteriaFromFilters](./foundation-alerts.foundationalerts.criteriafromfilters.md) | | Map&lt;string, string&gt; | **_(BETA)_** |
27
+ | [datasource](./foundation-alerts.foundationalerts.datasource.md) | | Datasource | **_(BETA)_** |
28
+ | [dataSubscription](./foundation-alerts.foundationalerts.datasubscription.md) | | Subscription | **_(BETA)_** |
29
+ | [displayState](./foundation-alerts.foundationalerts.displaystate.md) | | displayState | **_(BETA)_** |
30
+ | [filters](./foundation-alerts.foundationalerts.filters.md) | | { name: string; callback: () =&gt; void; icon: { name: string; }; }\[\] | **_(BETA)_** |
31
+ | [items](./foundation-alerts.foundationalerts.items.md) | | AlertRule\[\] | **_(BETA)_** |
32
+ | [ready](./foundation-alerts.foundationalerts.ready.md) | | boolean | **_(BETA)_** |
33
+
34
+ ## Methods
35
+
36
+ | Method | Modifiers | Description |
37
+ | --- | --- | --- |
38
+ | [connectedCallback()](./foundation-alerts.foundationalerts.connectedcallback.md) | | **_(BETA)_** |
39
+ | [criteriaFromFiltersChanged()](./foundation-alerts.foundationalerts.criteriafromfilterschanged.md) | | **_(BETA)_** |
40
+ | [delete(id)](./foundation-alerts.foundationalerts.delete.md) | | **_(BETA)_** |
41
+ | [disconnectedCallback()](./foundation-alerts.foundationalerts.disconnectedcallback.md) | | **_(BETA)_** |
42
+ | [handleAddAlertAction()](./foundation-alerts.foundationalerts.handleaddalertaction.md) | | **_(BETA)_** |
43
+ | [handleEditAlertAction(item)](./foundation-alerts.foundationalerts.handleeditalertaction.md) | | **_(BETA)_** |
44
+ | [toogleStatus({ RULE\_STATUS, DYNAMIC\_NOTIFY\_RULE\_ID: ID, })](./foundation-alerts.foundationalerts.tooglestatus.md) | | **_(BETA)_** |
45
+
@@ -0,0 +1,14 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [ready](./foundation-alerts.foundationalerts.ready.md)
4
+
5
+ ## FoundationAlerts.ready property
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ ready: boolean;
14
+ ```
@@ -0,0 +1,25 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlerts](./foundation-alerts.foundationalerts.md) &gt; [toogleStatus](./foundation-alerts.foundationalerts.tooglestatus.md)
4
+
5
+ ## FoundationAlerts.toogleStatus() method
6
+
7
+ > 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.
8
+ >
9
+
10
+ **Signature:**
11
+
12
+ ```typescript
13
+ toogleStatus({ RULE_STATUS, DYNAMIC_NOTIFY_RULE_ID: ID, }: AlertRuleRow): Promise<Message>;
14
+ ```
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | --- | --- | --- |
20
+ | { RULE\_STATUS, DYNAMIC\_NOTIFY\_RULE\_ID: ID, } | AlertRuleRow | |
21
+
22
+ **Returns:**
23
+
24
+ Promise&lt;Message&gt;
25
+
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlertsStyles](./foundation-alerts.foundationalertsstyles.md)
4
+
5
+ ## FoundationAlertsStyles variable
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ FoundationAlertsStyles: import("@microsoft/fast-element").ElementStyles
12
+ ```
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [FoundationAlertsTemplate](./foundation-alerts.foundationalertstemplate.md)
4
+
5
+ ## FoundationAlertsTemplate variable
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ FoundationAlertsTemplate: import("@microsoft/fast-element").ViewTemplate<FoundationAlerts, any>
12
+ ```
@@ -0,0 +1,33 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md)
4
+
5
+ ## foundation-alerts package
6
+
7
+ ## Classes
8
+
9
+ | Class | Description |
10
+ | --- | --- |
11
+ | [FoundationAlerts](./foundation-alerts.foundationalerts.md) | **_(BETA)_** Foundation alerts component for handle alerts rules list Allow creating, disabling and deleting alerts |
12
+ | [ZeroAlerts](./foundation-alerts.zeroalerts.md) | ZeroAlerts. |
13
+
14
+ ## Functions
15
+
16
+ | Function | Description |
17
+ | --- | --- |
18
+ | [configure(config)](./foundation-alerts.configure.md) | configure. |
19
+
20
+ ## Interfaces
21
+
22
+ | Interface | Description |
23
+ | --- | --- |
24
+ | [AlertConfig](./foundation-alerts.alertconfig.md) | AlertConfig DI interface. |
25
+
26
+ ## Variables
27
+
28
+ | Variable | Description |
29
+ | --- | --- |
30
+ | [defaultAlertConfig](./foundation-alerts.defaultalertconfig.md) | Default AlertConfig DI implementation. |
31
+ | [FoundationAlertsStyles](./foundation-alerts.foundationalertsstyles.md) | |
32
+ | [FoundationAlertsTemplate](./foundation-alerts.foundationalertstemplate.md) | |
33
+
@@ -0,0 +1,39 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-alerts](./foundation-alerts.md) &gt; [ZeroAlerts](./foundation-alerts.zeroalerts.md)
4
+
5
+ ## ZeroAlerts class
6
+
7
+ ZeroAlerts.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class ZeroAlerts extends FoundationAlerts
13
+ ```
14
+ **Extends:** [FoundationAlerts](./foundation-alerts.foundationalerts.md)
15
+
16
+ ## Remarks
17
+
18
+ A zero version that pre-registers zero components and uses the zero design system. ZeroAlerts and its components won't bloat the core bundle as these are only loaded on-demand when in use.
19
+
20
+ ## Example 1
21
+
22
+
23
+ ```ts
24
+ import { ZeroAlerts } from '@genesislcap/foundation-alerts';
25
+ ...
26
+ ZeroAlerts
27
+ ```
28
+
29
+ ## Example 2
30
+
31
+ Load the micro frontend on-demand
32
+
33
+ ```ts
34
+
35
+ const { ZeroAlerts } = await import('@genesislcap/foundation-alerts');
36
+ return ZeroAlerts;
37
+ },
38
+ ```
39
+
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md)
4
+
5
+ ## API Reference
6
+
7
+ ## Packages
8
+
9
+ | Package | Description |
10
+ | --- | --- |
11
+ | [@genesislcap/foundation-alerts](./foundation-alerts.md) | |
12
+
@@ -0,0 +1,109 @@
1
+ ## API Report File for "@genesislcap/foundation-alerts"
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 { Connect } from '@genesislcap/foundation-comms';
8
+ import { Datasource } from '@genesislcap/foundation-comms';
9
+ import { ElementStyles } from '@microsoft/fast-element';
10
+ import { FASTElement } from '@microsoft/fast-element';
11
+ import { InterfaceSymbol } from '@microsoft/fast-foundation';
12
+ import { Message } from '@genesislcap/foundation-comms';
13
+ import { PartialFASTElementDefinition } from '@microsoft/fast-element';
14
+ import { Subscription } from 'rxjs';
15
+ import { SyntheticViewTemplate } from '@microsoft/fast-element';
16
+ import { TemplateElementDependency } from '@genesislcap/foundation-ui';
17
+ import { ViewTemplate } from '@microsoft/fast-element';
18
+
19
+ // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AlertConfig" because one of its declarations is marked as @internal
20
+ //
21
+ // @public
22
+ export interface AlertConfig extends PartialFASTElementDefinition {
23
+ designSystemPrefix: string;
24
+ // Warning: (ae-forgotten-export) The symbol "TemplateOptions" needs to be exported by the entry point index.d.ts
25
+ templateOptions: TemplateOptions;
26
+ }
27
+
28
+ // @internal
29
+ export const AlertConfig: InterfaceSymbol<AlertConfig>;
30
+
31
+ // Warning: (ae-incompatible-release-tags) The symbol "configure" is marked as @public, but its signature references "FoundationAlerts" which is marked as @beta
32
+ //
33
+ // @public
34
+ export function configure(config: Partial<AlertConfig>): Promise<FoundationAlerts>;
35
+
36
+ // @public
37
+ export const defaultAlertConfig: AlertConfig;
38
+
39
+ // @beta
40
+ export class FoundationAlerts extends FASTElement {
41
+ // (undocumented)
42
+ alertConfig: AlertConfig;
43
+ // (undocumented)
44
+ alertEditItemData: AlertRule;
45
+ // (undocumented)
46
+ connect: Connect;
47
+ // (undocumented)
48
+ connectedCallback(): Promise<void>;
49
+ // (undocumented)
50
+ criteriaFromFilters: Map<string, string>;
51
+ // (undocumented)
52
+ criteriaFromFiltersChanged(): void;
53
+ // (undocumented)
54
+ datasource: Datasource;
55
+ // (undocumented)
56
+ dataSubscription: Subscription;
57
+ // Warning: (ae-forgotten-export) The symbol "AlertRuleRow" needs to be exported by the entry point index.d.ts
58
+ //
59
+ // (undocumented)
60
+ delete(id: AlertRuleRow['DYNAMIC_NOTIFY_RULE_ID']): Promise<Message>;
61
+ // (undocumented)
62
+ disconnectedCallback(): void;
63
+ // Warning: (ae-forgotten-export) The symbol "displayState" needs to be exported by the entry point index.d.ts
64
+ //
65
+ // (undocumented)
66
+ displayState: displayState;
67
+ // (undocumented)
68
+ filters: {
69
+ name: string;
70
+ callback: () => void;
71
+ icon: {
72
+ name: string;
73
+ };
74
+ }[];
75
+ // (undocumented)
76
+ handleAddAlertAction(): void;
77
+ // (undocumented)
78
+ handleEditAlertAction(item: any): void;
79
+ // Warning: (ae-forgotten-export) The symbol "AlertRule" needs to be exported by the entry point index.d.ts
80
+ //
81
+ // (undocumented)
82
+ items: AlertRule[];
83
+ // (undocumented)
84
+ ready: boolean;
85
+ // (undocumented)
86
+ toogleStatus({ RULE_STATUS, DYNAMIC_NOTIFY_RULE_ID: ID, }: AlertRuleRow): Promise<Message>;
87
+ }
88
+
89
+ // @public (undocumented)
90
+ export const FoundationAlertsStyles: ElementStyles;
91
+
92
+ // Warning: (ae-incompatible-release-tags) The symbol "FoundationAlertsTemplate" is marked as @public, but its signature references "FoundationAlerts" which is marked as @beta
93
+ //
94
+ // @public (undocumented)
95
+ export const FoundationAlertsTemplate: ViewTemplate<FoundationAlerts, any>;
96
+
97
+ // Warning: (ae-incompatible-release-tags) The symbol "ZeroAlerts" is marked as @public, but its signature references "FoundationAlerts" which is marked as @beta
98
+ //
99
+ // @public
100
+ export class ZeroAlerts extends FoundationAlerts {
101
+ // @internal (undocumented)
102
+ connectedCallback(): Promise<void>;
103
+ // @internal (undocumented)
104
+ protected loadRemotes(): Promise<void>;
105
+ }
106
+
107
+ // (No @packageDocumentation comment for this package)
108
+
109
+ ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-alerts",
3
3
  "description": "Genesis Foundation Alerts",
4
- "version": "14.184.0",
4
+ "version": "14.185.0",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-alerts.d.ts",
@@ -46,6 +46,7 @@
46
46
  "build": "genx build -b ts",
47
47
  "build:webpack": "genx build",
48
48
  "build:webpack:stats": "genx analyze",
49
+ "circular": "npx -y madge --extensions ts --circular ./src",
49
50
  "clean": "rimraf dist tsconfig.tsbuildinfo",
50
51
  "dev": "genx dev -b webpack",
51
52
  "dev:tsc": "genx dev -b ts",
@@ -60,22 +61,29 @@
60
61
  "test:unit:watch": "genx test --watch",
61
62
  "test:debug": "genx test --debug"
62
63
  },
64
+ "madge": {
65
+ "detectiveOptions": {
66
+ "ts": {
67
+ "skipTypeImports": true
68
+ }
69
+ }
70
+ },
63
71
  "devDependencies": {
64
- "@genesislcap/foundation-testing": "14.184.0",
65
- "@genesislcap/genx": "14.184.0",
66
- "@genesislcap/rollup-builder": "14.184.0",
67
- "@genesislcap/ts-builder": "14.184.0",
68
- "@genesislcap/uvu-playwright-builder": "14.184.0",
69
- "@genesislcap/vite-builder": "14.184.0",
70
- "@genesislcap/webpack-builder": "14.184.0",
71
- "rimraf": "^3.0.2"
72
+ "@genesislcap/foundation-testing": "14.185.0",
73
+ "@genesislcap/genx": "14.185.0",
74
+ "@genesislcap/rollup-builder": "14.185.0",
75
+ "@genesislcap/ts-builder": "14.185.0",
76
+ "@genesislcap/uvu-playwright-builder": "14.185.0",
77
+ "@genesislcap/vite-builder": "14.185.0",
78
+ "@genesislcap/webpack-builder": "14.185.0",
79
+ "rimraf": "^5.0.0"
72
80
  },
73
81
  "dependencies": {
74
- "@genesislcap/foundation-comms": "14.184.0",
75
- "@genesislcap/foundation-logger": "14.184.0",
76
- "@genesislcap/foundation-ui": "14.184.0",
77
- "@genesislcap/foundation-utils": "14.184.0",
78
- "@genesislcap/foundation-zero": "14.184.0",
82
+ "@genesislcap/foundation-comms": "14.185.0",
83
+ "@genesislcap/foundation-logger": "14.185.0",
84
+ "@genesislcap/foundation-ui": "14.185.0",
85
+ "@genesislcap/foundation-utils": "14.185.0",
86
+ "@genesislcap/foundation-zero": "14.185.0",
79
87
  "@microsoft/fast-components": "^2.30.6",
80
88
  "@microsoft/fast-element": "^1.12.0",
81
89
  "@microsoft/fast-foundation": "^2.49.4",
@@ -93,5 +101,5 @@
93
101
  "access": "public"
94
102
  },
95
103
  "customElements": "dist/custom-elements.json",
96
- "gitHead": "8aef45b63f3c8b0336b3f8cc97ad79a36e9b5381"
104
+ "gitHead": "839487e6a0b1168d0ad6bf32c9e3a50504c775a0"
97
105
  }