@genesislcap/foundation-entity-management 14.24.4 → 14.25.0-bny.2
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.
- package/dist/custom-elements.json +206 -86
- package/dist/dts/entities/entities.d.ts +21 -4
- package/dist/dts/entities/entities.d.ts.map +1 -1
- package/dist/dts/entities/entities.styles.d.ts.map +1 -1
- package/dist/dts/entities/entities.template.d.ts.map +1 -1
- package/dist/dts/list/list.d.ts +0 -2
- package/dist/dts/list/list.d.ts.map +1 -1
- package/dist/dts/list/list.styles.d.ts.map +1 -1
- package/dist/dts/list/list.template.d.ts +0 -23
- package/dist/dts/list/list.template.d.ts.map +1 -1
- package/dist/dts/utils/index.d.ts +26 -0
- package/dist/dts/utils/index.d.ts.map +1 -1
- package/dist/esm/entities/entities.js +28 -5
- package/dist/esm/entities/entities.styles.js +6 -0
- package/dist/esm/entities/entities.template.js +17 -3
- package/dist/esm/list/list.js +2 -7
- package/dist/esm/list/list.styles.js +0 -6
- package/dist/esm/list/list.template.js +0 -35
- package/dist/esm/utils/index.js +25 -0
- package/dist/foundation-entity-management.api.json +198 -0
- package/dist/foundation-entity-management.d.ts +48 -4
- package/docs/api/foundation-entity-management.buttoncellrenderer.md +34 -0
- package/docs/api/foundation-entity-management.entitymanagement.create.md +17 -0
- package/docs/api/foundation-entity-management.entitymanagement.criteriachanged.md +22 -0
- package/docs/api/foundation-entity-management.entitymanagement.defaultentityvalues.md +11 -0
- package/docs/api/foundation-entity-management.entitymanagement.editentityform.md +11 -0
- package/docs/api/foundation-entity-management.entitymanagement.md +5 -0
- package/docs/api/foundation-entity-management.entitymanagement.modalposition.md +13 -0
- package/docs/api/foundation-entity-management.md +1 -0
- package/docs/api-report.md +34 -0
- package/package.json +18 -44
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [criteriaChanged](./foundation-entity-management.entitymanagement.criteriachanged.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.criteriaChanged() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
criteriaChanged(e: CustomEvent<string>): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| e | CustomEvent<string> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.defaultEntityValues property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
defaultEntityValues: any;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [editEntityForm](./foundation-entity-management.entitymanagement.editentityform.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.editEntityForm property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
editEntityForm: Form;
|
|
11
|
+
```
|
|
@@ -41,15 +41,18 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
41
41
|
| [createEvent](./foundation-entity-management.entitymanagement.createevent.md) | | string | Name of the event handler on the Genesis server which handles creating an entity |
|
|
42
42
|
| [createFormUiSchema](./foundation-entity-management.entitymanagement.createformuischema.md) | | any | |
|
|
43
43
|
| [datasourceConfig](./foundation-entity-management.entitymanagement.datasourceconfig.md) | | [DatasourceConfiguration](./foundation-entity-management.datasourceconfiguration.md) | The configuration which is used when interacting with the resource on the backend |
|
|
44
|
+
| [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md) | | any | |
|
|
44
45
|
| [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md) | | string | Name of the event handler on the Genesis server which handles deleting the entity |
|
|
45
46
|
| [editDialogTitle](./foundation-entity-management.entitymanagement.editdialogtitle.md) | | string | String which contains the text of the popup modal when the user is adding or editing an entity |
|
|
46
47
|
| [editedEntity](./foundation-entity-management.entitymanagement.editedentity.md) | | any | Disables the form while enabled to stop the user dispatching a large number of duplicate events |
|
|
48
|
+
| [editEntityForm](./foundation-entity-management.entitymanagement.editentityform.md) | | Form | |
|
|
47
49
|
| [editEntityModal](./foundation-entity-management.entitymanagement.editentitymodal.md) | | any | |
|
|
48
50
|
| [editModalVisible](./foundation-entity-management.entitymanagement.editmodalvisible.md) | | boolean | |
|
|
49
51
|
| [enableCellFlashing](./foundation-entity-management.entitymanagement.enablecellflashing.md) | | boolean | |
|
|
50
52
|
| [enableFilterBar](./foundation-entity-management.entitymanagement.enablefilterbar.md) | | boolean | |
|
|
51
53
|
| [entityLabel](./foundation-entity-management.entitymanagement.entitylabel.md) | | string | Label for the entity which has usages such as being shown in the title of the modal wen editing the entity |
|
|
52
54
|
| [formUiSchema](./foundation-entity-management.entitymanagement.formuischema.md) | | any | |
|
|
55
|
+
| [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md) | | 'centre' \| 'left' \| 'right' | Determines where the modal dialog will appear on screen |
|
|
53
56
|
| [persistColumnStateKey](./foundation-entity-management.entitymanagement.persistcolumnstatekey.md) | | string | This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it. |
|
|
54
57
|
| [readEvent](./foundation-entity-management.entitymanagement.readevent.md) | | string | |
|
|
55
58
|
| [readEventFn](./foundation-entity-management.entitymanagement.readeventfn.md) | | (...args: any\[\]) => {} | |
|
|
@@ -68,6 +71,8 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
68
71
|
| --- | --- | --- |
|
|
69
72
|
| [closeModal()](./foundation-entity-management.entitymanagement.closemodal.md) | | |
|
|
70
73
|
| [confirmDelete()](./foundation-entity-management.entitymanagement.confirmdelete.md) | | |
|
|
74
|
+
| [create()](./foundation-entity-management.entitymanagement.create.md) | | Show the entity create form |
|
|
75
|
+
| [criteriaChanged(e)](./foundation-entity-management.entitymanagement.criteriachanged.md) | | |
|
|
71
76
|
| [deepClone()](./foundation-entity-management.entitymanagement.deepclone.md) | | Override the deepClone method to ensure that observable attributes are cloned |
|
|
72
77
|
| [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) | | |
|
|
73
78
|
| [submitEntityChanges(e)](./foundation-entity-management.entitymanagement.submitentitychanges.md) | | Event handler for when the user submits the action for the currently open form, either editing or adding the entity |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-entity-management](./foundation-entity-management.md) > [EntityManagement](./foundation-entity-management.entitymanagement.md) > [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.modalPosition property
|
|
6
|
+
|
|
7
|
+
Determines where the modal dialog will appear on screen
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
modalPosition: 'centre' | 'left' | 'right';
|
|
13
|
+
```
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
| Variable | Description |
|
|
19
19
|
| --- | --- |
|
|
20
|
+
| [buttonCellRenderer](./foundation-entity-management.buttoncellrenderer.md) | |
|
|
20
21
|
| [getErrorFormat](./foundation-entity-management.geterrorformat.md) | Format the error as a string with a different format depending on whether <code>err</code> has a <code>FIELD</code> property or not |
|
|
21
22
|
| [logger](./foundation-entity-management.logger.md) | |
|
|
22
23
|
| [UsersColumnConfig](./foundation-entity-management.userscolumnconfig.md) | Defines the default columns which are present on the user management component |
|
package/docs/api-report.md
CHANGED
|
@@ -13,6 +13,7 @@ import { Controller } from '@microsoft/fast-element';
|
|
|
13
13
|
import { DatasourceOptions } from '@genesislcap/foundation-comms';
|
|
14
14
|
import { DOMContainer } from '@genesislcap/foundation-utils';
|
|
15
15
|
import { FASTElement } from '@microsoft/fast-element';
|
|
16
|
+
import { Form } from '@genesislcap/foundation-forms';
|
|
16
17
|
import { FoundationAnalytics } from '@genesislcap/foundation-comms';
|
|
17
18
|
import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
|
|
18
19
|
import { GridProRendererTypes } from '@genesislcap/grid-pro';
|
|
@@ -24,6 +25,31 @@ import { RouterConfiguration } from '@microsoft/fast-router';
|
|
|
24
25
|
import { Session } from '@genesislcap/foundation-comms';
|
|
25
26
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
26
27
|
|
|
28
|
+
// @public (undocumented)
|
|
29
|
+
export const buttonCellRenderer: (title: any, clickHandler: any) => {
|
|
30
|
+
width: number;
|
|
31
|
+
pinned: string;
|
|
32
|
+
enableCellChangeFlash: boolean;
|
|
33
|
+
cellStyle: {
|
|
34
|
+
padding: string;
|
|
35
|
+
lineHeight: string;
|
|
36
|
+
};
|
|
37
|
+
filter: boolean;
|
|
38
|
+
suppressFiltersToolPanel: boolean;
|
|
39
|
+
suppressColumnsToolPanel: boolean;
|
|
40
|
+
headerName: string;
|
|
41
|
+
minWidth: number;
|
|
42
|
+
maxWidth: number;
|
|
43
|
+
cellRendererSelector: (params: any) => {
|
|
44
|
+
component: string;
|
|
45
|
+
params: {
|
|
46
|
+
actionClick: any;
|
|
47
|
+
actionName: any;
|
|
48
|
+
appearance: string;
|
|
49
|
+
};
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
|
|
27
53
|
// @public
|
|
28
54
|
export type DatasourceConfiguration = Omit<DatasourceOptions, 'resourceName' | 'request'>;
|
|
29
55
|
|
|
@@ -44,17 +70,24 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
44
70
|
protected connect: Connect;
|
|
45
71
|
// @internal
|
|
46
72
|
connectedCallback(): Promise<void>;
|
|
73
|
+
create(): void;
|
|
47
74
|
createEvent: string;
|
|
48
75
|
// (undocumented)
|
|
49
76
|
createFormUiSchema: any;
|
|
77
|
+
// (undocumented)
|
|
78
|
+
criteriaChanged(e: CustomEvent<string>): void;
|
|
50
79
|
datasourceConfig: DatasourceConfiguration;
|
|
51
80
|
deepClone(): Node;
|
|
81
|
+
// (undocumented)
|
|
82
|
+
defaultEntityValues: any;
|
|
52
83
|
// @internal
|
|
53
84
|
deleteEntity(e: CustomEvent): Promise<void>;
|
|
54
85
|
deleteEvent: string;
|
|
55
86
|
editDialogTitle: string;
|
|
56
87
|
editedEntity: any;
|
|
57
88
|
// (undocumented)
|
|
89
|
+
editEntityForm: Form;
|
|
90
|
+
// (undocumented)
|
|
58
91
|
editEntityModal: any;
|
|
59
92
|
// (undocumented)
|
|
60
93
|
editModalVisible: boolean;
|
|
@@ -73,6 +106,7 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
73
106
|
formResourceName: string;
|
|
74
107
|
// (undocumented)
|
|
75
108
|
formUiSchema: any;
|
|
109
|
+
modalPosition: 'centre' | 'left' | 'right';
|
|
76
110
|
persistColumnStateKey: string;
|
|
77
111
|
// (undocumented)
|
|
78
112
|
readEvent: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-entity-management",
|
|
3
3
|
"description": "Genesis Foundation Entity Management",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.25.0-bny.2",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -14,13 +14,12 @@
|
|
|
14
14
|
},
|
|
15
15
|
"scripts": {
|
|
16
16
|
"build": "genx build",
|
|
17
|
-
"build:webpack": "
|
|
18
|
-
"build:webpack:
|
|
19
|
-
"build:webpack:stats": "cross-env ANALYZE=1 npm run build:webpack",
|
|
17
|
+
"build:webpack": "genx build -b webpack",
|
|
18
|
+
"build:webpack:stats": "genx analyze -b webpack",
|
|
20
19
|
"clean": "genx clean",
|
|
21
|
-
"dev": "npm run dev:webpack
|
|
20
|
+
"dev": "npm run dev:webpack",
|
|
22
21
|
"dev:no-open": "npm run dev:webpack -- --no-open",
|
|
23
|
-
"dev:webpack": "cross-env NODE_ENV=development API_HOST=$npm_package_config_API_HOST DEFAULT_USER=$npm_package_config_DEFAULT_USER DEFAULT_PASSWORD=$npm_package_config_DEFAULT_PASSWORD webpack
|
|
22
|
+
"dev:webpack": "cross-env NODE_ENV=development API_HOST=$npm_package_config_API_HOST DEFAULT_USER=$npm_package_config_DEFAULT_USER DEFAULT_PASSWORD=$npm_package_config_DEFAULT_PASSWORD genx dev -b webpack",
|
|
24
23
|
"dev:webpack:https": "npm run dev:webpack -- --https",
|
|
25
24
|
"serve": "genx serve",
|
|
26
25
|
"test": "npm run test:unit",
|
|
@@ -39,57 +38,32 @@
|
|
|
39
38
|
"test:unit:watch": "watchlist src test -- npm run test:unit"
|
|
40
39
|
},
|
|
41
40
|
"devDependencies": {
|
|
42
|
-
"@genesislcap/foundation-testing": "
|
|
43
|
-
"@genesislcap/genx": "
|
|
41
|
+
"@genesislcap/foundation-testing": "14.25.0-bny.2",
|
|
42
|
+
"@genesislcap/genx": "14.25.0-bny.2",
|
|
44
43
|
"@playwright/test": "^1.18.1",
|
|
45
44
|
"bulma": "^0.9.3",
|
|
46
45
|
"c8": "^7.11.0",
|
|
47
|
-
"camel-case": "^4.1.2",
|
|
48
|
-
"clean-webpack-plugin": "^4.0.0",
|
|
49
|
-
"copyfiles": "^2.4.1",
|
|
50
46
|
"cross-env": "^7.0.3",
|
|
51
|
-
"csp-html-webpack-plugin": "^5.1.0",
|
|
52
|
-
"css-loader": "^6.6.0",
|
|
53
|
-
"cssnano": "^5.0.17",
|
|
54
47
|
"esm": "^3.2.25",
|
|
55
48
|
"expect-playwright": "^0.8.0",
|
|
56
|
-
"file-loader": "^6.2.0",
|
|
57
|
-
"html-loader": "^3.1.0",
|
|
58
|
-
"html-webpack-plugin": "^5.3.1",
|
|
59
49
|
"jsdom": "^19.0.0",
|
|
60
|
-
"mini-css-extract-plugin": "^2.5.3",
|
|
61
50
|
"playwright-lighthouse": "^2.2.2",
|
|
62
51
|
"playwright-test": "^7.2.1",
|
|
63
|
-
"portfinder-sync": "^0.0.2",
|
|
64
|
-
"postcss": "^8.2.8",
|
|
65
|
-
"postcss-import": "^14.0.0",
|
|
66
|
-
"postcss-loader": "^6.2.1",
|
|
67
|
-
"postcss-preset-env": "^7.0.1",
|
|
68
|
-
"sass": "^1.49.7",
|
|
69
|
-
"terser-webpack-plugin": "^5.3.1",
|
|
70
|
-
"to-string-loader": "^1.2.0",
|
|
71
|
-
"ts-loader": "9.3.1",
|
|
72
|
-
"tsconfig-paths-webpack-plugin": "^3.5.1",
|
|
73
52
|
"tsm": "^2.2.1",
|
|
74
53
|
"typescript": "^4.5.5",
|
|
75
54
|
"uvu": "0.5.4",
|
|
76
|
-
"watchlist": "^0.3.1"
|
|
77
|
-
"webpack": "^5.45.1",
|
|
78
|
-
"webpack-bundle-analyzer": "^4.5.0",
|
|
79
|
-
"webpack-cli": "^4.5.0",
|
|
80
|
-
"webpack-dev-server": "^4.0.0-beta.3",
|
|
81
|
-
"webpack-merge": "^5.7.3"
|
|
55
|
+
"watchlist": "^0.3.1"
|
|
82
56
|
},
|
|
83
57
|
"dependencies": {
|
|
84
|
-
"@genesislcap/foundation-comms": "
|
|
85
|
-
"@genesislcap/foundation-errors": "
|
|
86
|
-
"@genesislcap/foundation-forms": "
|
|
87
|
-
"@genesislcap/foundation-login": "
|
|
88
|
-
"@genesislcap/foundation-ui": "
|
|
89
|
-
"@genesislcap/foundation-utils": "
|
|
90
|
-
"@genesislcap/foundation-zero": "
|
|
91
|
-
"@genesislcap/foundation-zero-grid-pro": "
|
|
92
|
-
"@genesislcap/grid-pro": "
|
|
58
|
+
"@genesislcap/foundation-comms": "14.25.0-bny.2",
|
|
59
|
+
"@genesislcap/foundation-errors": "14.25.0-bny.2",
|
|
60
|
+
"@genesislcap/foundation-forms": "14.25.0-bny.2",
|
|
61
|
+
"@genesislcap/foundation-login": "14.25.0-bny.2",
|
|
62
|
+
"@genesislcap/foundation-ui": "14.25.0-bny.2",
|
|
63
|
+
"@genesislcap/foundation-utils": "14.25.0-bny.2",
|
|
64
|
+
"@genesislcap/foundation-zero": "14.25.0-bny.2",
|
|
65
|
+
"@genesislcap/foundation-zero-grid-pro": "14.25.0-bny.2",
|
|
66
|
+
"@genesislcap/grid-pro": "14.25.0-bny.2",
|
|
93
67
|
"@microsoft/fast-components": "^2.21.3",
|
|
94
68
|
"@microsoft/fast-element": "^1.7.0",
|
|
95
69
|
"@microsoft/fast-foundation": "^2.33.2",
|
|
@@ -114,5 +88,5 @@
|
|
|
114
88
|
"access": "public"
|
|
115
89
|
},
|
|
116
90
|
"customElements": "dist/custom-elements.json",
|
|
117
|
-
"gitHead": "
|
|
91
|
+
"gitHead": "7b641c5cd4607901def78b3bf4b0448edf20e591"
|
|
118
92
|
}
|