@genesislcap/foundation-entity-management 14.203.1 → 14.203.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 +103 -11
- package/dist/dts/entities/entities.d.ts +28 -18
- package/dist/dts/entities/entities.d.ts.map +1 -1
- package/dist/dts/entities/entities.template.d.ts.map +1 -1
- package/dist/dts/list/list.d.ts +1 -0
- package/dist/dts/list/list.d.ts.map +1 -1
- package/dist/dts/profiles/profiles.d.ts.map +1 -1
- package/dist/dts/types.d.ts +11 -0
- package/dist/dts/types.d.ts.map +1 -1
- package/dist/esm/entities/entities.js +67 -17
- package/dist/esm/entities/entities.styles.js +2 -2
- package/dist/esm/entities/entities.template.js +6 -5
- package/dist/esm/list/list.js +4 -0
- package/dist/esm/profiles/profiles.js +2 -1
- package/dist/esm/types.js +13 -0
- package/dist/foundation-entity-management.api.json +181 -30
- package/dist/foundation-entity-management.d.ts +40 -15
- package/docs/api/foundation-entity-management.entitymanagement.gettitlebasedonactionortype.md +24 -0
- package/docs/api/foundation-entity-management.entitymanagement.md +4 -1
- package/docs/api/foundation-entity-management.entitymanagement.modalformtitle.md +13 -0
- package/docs/api/foundation-entity-management.entitymanagement.modalformtype.md +13 -0
- package/docs/api/foundation-entity-management.entitymanagement.selectionchanged.md +24 -0
- package/docs/api-report.md +11 -4
- package/package.json +21 -21
- package/docs/api/foundation-entity-management.entitymanagement.editdialogtitle.md +0 -13
package/dist/esm/list/list.js
CHANGED
|
@@ -43,6 +43,7 @@ let List = class List extends LifecycleMixin(FASTElement) {
|
|
|
43
43
|
}
|
|
44
44
|
});
|
|
45
45
|
this.grid.gridApi.addEventListener(Events.EVENT_ROW_CLICKED, (e) => this.select(e));
|
|
46
|
+
this.grid.gridApi.addEventListener(Events.EVENT_SELECTION_CHANGED, (e) => this.selectionChanged(e));
|
|
46
47
|
if (this.updateEvent) {
|
|
47
48
|
this.grid.gridApi.addEventListener(Events.EVENT_CELL_EDIT_REQUEST, (e) => this.onCellEditingStopped(e));
|
|
48
49
|
}
|
|
@@ -136,6 +137,9 @@ let List = class List extends LifecycleMixin(FASTElement) {
|
|
|
136
137
|
select(e) {
|
|
137
138
|
this.$emit('rowSelected', e);
|
|
138
139
|
}
|
|
140
|
+
selectionChanged(e) {
|
|
141
|
+
this.$emit('selectionChanged', e);
|
|
142
|
+
}
|
|
139
143
|
delete(e) {
|
|
140
144
|
return __awaiter(this, void 0, void 0, function* () {
|
|
141
145
|
this.$emit('delete-entity', e);
|
|
@@ -2,6 +2,7 @@ import { __awaiter, __decorate } from "tslib";
|
|
|
2
2
|
import { Auth } from '@genesislcap/foundation-comms';
|
|
3
3
|
import { customElement } from '@microsoft/fast-element';
|
|
4
4
|
import { EntityManagement, styles, template } from '../entities';
|
|
5
|
+
import { CrudAction } from '../types';
|
|
5
6
|
import { editProfileFormSchema } from './editProfileSchema';
|
|
6
7
|
/**
|
|
7
8
|
* Main class which defined the profile management functionality
|
|
@@ -73,7 +74,7 @@ let Profiles = class Profiles extends EntityManagement {
|
|
|
73
74
|
const deleteReq = yield this.connect.commitEvent(this.deleteEvent, {
|
|
74
75
|
DETAILS: { NAME: this.selectedEntity.PROFILE_NAME },
|
|
75
76
|
});
|
|
76
|
-
this.
|
|
77
|
+
this.handleNotify(CrudAction.Delete, deleteReq.ERROR);
|
|
77
78
|
});
|
|
78
79
|
}
|
|
79
80
|
};
|
package/dist/esm/types.js
CHANGED
|
@@ -15,3 +15,16 @@ export var CrudMenuPosition;
|
|
|
15
15
|
CrudMenuPosition["Action"] = "action";
|
|
16
16
|
CrudMenuPosition["None"] = "none";
|
|
17
17
|
})(CrudMenuPosition || (CrudMenuPosition = {}));
|
|
18
|
+
export var CrudAction;
|
|
19
|
+
(function (CrudAction) {
|
|
20
|
+
CrudAction["Create"] = "create";
|
|
21
|
+
CrudAction["Read"] = "read";
|
|
22
|
+
CrudAction["Update"] = "update";
|
|
23
|
+
CrudAction["Delete"] = "delete";
|
|
24
|
+
})(CrudAction || (CrudAction = {}));
|
|
25
|
+
export var ModalFormType;
|
|
26
|
+
(function (ModalFormType) {
|
|
27
|
+
ModalFormType["Create"] = "create";
|
|
28
|
+
ModalFormType["Read"] = "read";
|
|
29
|
+
ModalFormType["Update"] = "update";
|
|
30
|
+
})(ModalFormType || (ModalFormType = {}));
|
|
@@ -919,36 +919,6 @@
|
|
|
919
919
|
"isAbstract": false,
|
|
920
920
|
"name": "disconnectedCallback"
|
|
921
921
|
},
|
|
922
|
-
{
|
|
923
|
-
"kind": "Property",
|
|
924
|
-
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editDialogTitle:member",
|
|
925
|
-
"docComment": "/**\n * String which contains the text of the popup modal when the user is adding or editing an entity\n */\n",
|
|
926
|
-
"excerptTokens": [
|
|
927
|
-
{
|
|
928
|
-
"kind": "Content",
|
|
929
|
-
"text": "editDialogTitle: "
|
|
930
|
-
},
|
|
931
|
-
{
|
|
932
|
-
"kind": "Content",
|
|
933
|
-
"text": "string"
|
|
934
|
-
},
|
|
935
|
-
{
|
|
936
|
-
"kind": "Content",
|
|
937
|
-
"text": ";"
|
|
938
|
-
}
|
|
939
|
-
],
|
|
940
|
-
"isReadonly": false,
|
|
941
|
-
"isOptional": false,
|
|
942
|
-
"releaseTag": "Public",
|
|
943
|
-
"name": "editDialogTitle",
|
|
944
|
-
"propertyTypeTokenRange": {
|
|
945
|
-
"startIndex": 1,
|
|
946
|
-
"endIndex": 2
|
|
947
|
-
},
|
|
948
|
-
"isStatic": false,
|
|
949
|
-
"isProtected": false,
|
|
950
|
-
"isAbstract": false
|
|
951
|
-
},
|
|
952
922
|
{
|
|
953
923
|
"kind": "Property",
|
|
954
924
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editedEntity:member",
|
|
@@ -1340,6 +1310,64 @@
|
|
|
1340
1310
|
"isProtected": false,
|
|
1341
1311
|
"isAbstract": false
|
|
1342
1312
|
},
|
|
1313
|
+
{
|
|
1314
|
+
"kind": "Method",
|
|
1315
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#getTitleBasedOnActionOrType:member(1)",
|
|
1316
|
+
"docComment": "/**\n * The helper function to determine the title of the modal form or button based on the action or type\n *\n * @param actionOrType - The crud action or modal form type\n */\n",
|
|
1317
|
+
"excerptTokens": [
|
|
1318
|
+
{
|
|
1319
|
+
"kind": "Content",
|
|
1320
|
+
"text": "getTitleBasedOnActionOrType(actionOrType: "
|
|
1321
|
+
},
|
|
1322
|
+
{
|
|
1323
|
+
"kind": "Reference",
|
|
1324
|
+
"text": "CrudAction",
|
|
1325
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!~CrudAction:enum"
|
|
1326
|
+
},
|
|
1327
|
+
{
|
|
1328
|
+
"kind": "Content",
|
|
1329
|
+
"text": " | "
|
|
1330
|
+
},
|
|
1331
|
+
{
|
|
1332
|
+
"kind": "Reference",
|
|
1333
|
+
"text": "ModalFormType",
|
|
1334
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!~ModalFormType:enum"
|
|
1335
|
+
},
|
|
1336
|
+
{
|
|
1337
|
+
"kind": "Content",
|
|
1338
|
+
"text": "): "
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
"kind": "Content",
|
|
1342
|
+
"text": "string"
|
|
1343
|
+
},
|
|
1344
|
+
{
|
|
1345
|
+
"kind": "Content",
|
|
1346
|
+
"text": ";"
|
|
1347
|
+
}
|
|
1348
|
+
],
|
|
1349
|
+
"isStatic": false,
|
|
1350
|
+
"returnTypeTokenRange": {
|
|
1351
|
+
"startIndex": 5,
|
|
1352
|
+
"endIndex": 6
|
|
1353
|
+
},
|
|
1354
|
+
"releaseTag": "Public",
|
|
1355
|
+
"isProtected": false,
|
|
1356
|
+
"overloadIndex": 1,
|
|
1357
|
+
"parameters": [
|
|
1358
|
+
{
|
|
1359
|
+
"parameterName": "actionOrType",
|
|
1360
|
+
"parameterTypeTokenRange": {
|
|
1361
|
+
"startIndex": 1,
|
|
1362
|
+
"endIndex": 4
|
|
1363
|
+
},
|
|
1364
|
+
"isOptional": false
|
|
1365
|
+
}
|
|
1366
|
+
],
|
|
1367
|
+
"isOptional": false,
|
|
1368
|
+
"isAbstract": false,
|
|
1369
|
+
"name": "getTitleBasedOnActionOrType"
|
|
1370
|
+
},
|
|
1343
1371
|
{
|
|
1344
1372
|
"kind": "Property",
|
|
1345
1373
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#gridOptions:member",
|
|
@@ -1618,6 +1646,67 @@
|
|
|
1618
1646
|
"isProtected": false,
|
|
1619
1647
|
"isAbstract": false
|
|
1620
1648
|
},
|
|
1649
|
+
{
|
|
1650
|
+
"kind": "Property",
|
|
1651
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalFormTitle:member",
|
|
1652
|
+
"docComment": "/**\n * Getter for the title of the modal form\n */\n",
|
|
1653
|
+
"excerptTokens": [
|
|
1654
|
+
{
|
|
1655
|
+
"kind": "Content",
|
|
1656
|
+
"text": "get modalFormTitle(): "
|
|
1657
|
+
},
|
|
1658
|
+
{
|
|
1659
|
+
"kind": "Content",
|
|
1660
|
+
"text": "string"
|
|
1661
|
+
},
|
|
1662
|
+
{
|
|
1663
|
+
"kind": "Content",
|
|
1664
|
+
"text": ";"
|
|
1665
|
+
}
|
|
1666
|
+
],
|
|
1667
|
+
"isReadonly": true,
|
|
1668
|
+
"isOptional": false,
|
|
1669
|
+
"releaseTag": "Public",
|
|
1670
|
+
"name": "modalFormTitle",
|
|
1671
|
+
"propertyTypeTokenRange": {
|
|
1672
|
+
"startIndex": 1,
|
|
1673
|
+
"endIndex": 2
|
|
1674
|
+
},
|
|
1675
|
+
"isStatic": false,
|
|
1676
|
+
"isProtected": false,
|
|
1677
|
+
"isAbstract": false
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"kind": "Property",
|
|
1681
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalFormType:member",
|
|
1682
|
+
"docComment": "/**\n * The type of form that is currently being displayed in the modal\n */\n",
|
|
1683
|
+
"excerptTokens": [
|
|
1684
|
+
{
|
|
1685
|
+
"kind": "Content",
|
|
1686
|
+
"text": "modalFormType: "
|
|
1687
|
+
},
|
|
1688
|
+
{
|
|
1689
|
+
"kind": "Reference",
|
|
1690
|
+
"text": "ModalFormType",
|
|
1691
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!~ModalFormType:enum"
|
|
1692
|
+
},
|
|
1693
|
+
{
|
|
1694
|
+
"kind": "Content",
|
|
1695
|
+
"text": ";"
|
|
1696
|
+
}
|
|
1697
|
+
],
|
|
1698
|
+
"isReadonly": false,
|
|
1699
|
+
"isOptional": false,
|
|
1700
|
+
"releaseTag": "Public",
|
|
1701
|
+
"name": "modalFormType",
|
|
1702
|
+
"propertyTypeTokenRange": {
|
|
1703
|
+
"startIndex": 1,
|
|
1704
|
+
"endIndex": 2
|
|
1705
|
+
},
|
|
1706
|
+
"isStatic": false,
|
|
1707
|
+
"isProtected": false,
|
|
1708
|
+
"isAbstract": false
|
|
1709
|
+
},
|
|
1621
1710
|
{
|
|
1622
1711
|
"kind": "Property",
|
|
1623
1712
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalPosition:member",
|
|
@@ -2158,6 +2247,68 @@
|
|
|
2158
2247
|
"isProtected": false,
|
|
2159
2248
|
"isAbstract": false
|
|
2160
2249
|
},
|
|
2250
|
+
{
|
|
2251
|
+
"kind": "Method",
|
|
2252
|
+
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#selectionChanged:member(1)",
|
|
2253
|
+
"docComment": "/**\n * The event handler for when the selection changes in the grid.\n */\n",
|
|
2254
|
+
"excerptTokens": [
|
|
2255
|
+
{
|
|
2256
|
+
"kind": "Content",
|
|
2257
|
+
"text": "selectionChanged(event: "
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"kind": "Reference",
|
|
2261
|
+
"text": "CustomEvent",
|
|
2262
|
+
"canonicalReference": "!CustomEvent:interface"
|
|
2263
|
+
},
|
|
2264
|
+
{
|
|
2265
|
+
"kind": "Content",
|
|
2266
|
+
"text": "<"
|
|
2267
|
+
},
|
|
2268
|
+
{
|
|
2269
|
+
"kind": "Reference",
|
|
2270
|
+
"text": "SelectionChangedEvent",
|
|
2271
|
+
"canonicalReference": "@ag-grid-community/core!SelectionChangedEvent:interface"
|
|
2272
|
+
},
|
|
2273
|
+
{
|
|
2274
|
+
"kind": "Content",
|
|
2275
|
+
"text": ">"
|
|
2276
|
+
},
|
|
2277
|
+
{
|
|
2278
|
+
"kind": "Content",
|
|
2279
|
+
"text": "): "
|
|
2280
|
+
},
|
|
2281
|
+
{
|
|
2282
|
+
"kind": "Content",
|
|
2283
|
+
"text": "void"
|
|
2284
|
+
},
|
|
2285
|
+
{
|
|
2286
|
+
"kind": "Content",
|
|
2287
|
+
"text": ";"
|
|
2288
|
+
}
|
|
2289
|
+
],
|
|
2290
|
+
"isStatic": false,
|
|
2291
|
+
"returnTypeTokenRange": {
|
|
2292
|
+
"startIndex": 6,
|
|
2293
|
+
"endIndex": 7
|
|
2294
|
+
},
|
|
2295
|
+
"releaseTag": "Public",
|
|
2296
|
+
"isProtected": false,
|
|
2297
|
+
"overloadIndex": 1,
|
|
2298
|
+
"parameters": [
|
|
2299
|
+
{
|
|
2300
|
+
"parameterName": "event",
|
|
2301
|
+
"parameterTypeTokenRange": {
|
|
2302
|
+
"startIndex": 1,
|
|
2303
|
+
"endIndex": 5
|
|
2304
|
+
},
|
|
2305
|
+
"isOptional": false
|
|
2306
|
+
}
|
|
2307
|
+
],
|
|
2308
|
+
"isOptional": false,
|
|
2309
|
+
"isAbstract": false,
|
|
2310
|
+
"name": "selectionChanged"
|
|
2311
|
+
},
|
|
2161
2312
|
{
|
|
2162
2313
|
"kind": "Property",
|
|
2163
2314
|
"canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#shouldHideDeleteInColumn:member",
|
|
@@ -18,11 +18,13 @@ import type { GridProCaseType } from '@genesislcap/grid-pro';
|
|
|
18
18
|
import { GridProRendererTypes } from '@genesislcap/foundation-zero-grid-pro';
|
|
19
19
|
import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
|
|
20
20
|
import { Logger } from '@genesislcap/foundation-logger';
|
|
21
|
-
import
|
|
21
|
+
import { MessageError } from '@genesislcap/foundation-comms';
|
|
22
|
+
import { Modal } from '@genesislcap/foundation-ui';
|
|
22
23
|
import { PartialFASTElementDefinition } from '@microsoft/fast-element';
|
|
23
24
|
import { RendererEntry } from '@genesislcap/foundation-forms';
|
|
24
25
|
import { RouterConfiguration } from '@microsoft/fast-router';
|
|
25
26
|
import { SelectedOption } from '@genesislcap/foundation-ui';
|
|
27
|
+
import { SelectionChangedEvent } from '@ag-grid-community/core';
|
|
26
28
|
import { Session } from '@genesislcap/foundation-comms';
|
|
27
29
|
import { UiSchema } from '@genesislcap/foundation-forms';
|
|
28
30
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
@@ -51,6 +53,13 @@ declare type AdditionalEntry = string | UiSchema | {
|
|
|
51
53
|
*/
|
|
52
54
|
export declare const buttonCellRenderer: (title: any, clickHandler: any, contentTemplate: any) => ColDef;
|
|
53
55
|
|
|
56
|
+
declare enum CrudAction {
|
|
57
|
+
Create = "create",
|
|
58
|
+
Read = "read",
|
|
59
|
+
Update = "update",
|
|
60
|
+
Delete = "delete"
|
|
61
|
+
}
|
|
62
|
+
|
|
54
63
|
declare enum CrudMenuPosition {
|
|
55
64
|
Column = "column",
|
|
56
65
|
Top = "top",
|
|
@@ -271,9 +280,9 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
271
280
|
defaultEntityValues: Record<string, unknown>;
|
|
272
281
|
submitting: boolean;
|
|
273
282
|
/**
|
|
274
|
-
*
|
|
283
|
+
* The type of form that is currently being displayed in the modal
|
|
275
284
|
*/
|
|
276
|
-
|
|
285
|
+
modalFormType: ModalFormType;
|
|
277
286
|
editModalVisible: boolean;
|
|
278
287
|
editModalVisibleChanged(): void;
|
|
279
288
|
editEntityModal: Modal;
|
|
@@ -316,6 +325,15 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
316
325
|
* The Id of the crud buttons wrapper element
|
|
317
326
|
*/
|
|
318
327
|
crudMenuWrapper: any;
|
|
328
|
+
/**
|
|
329
|
+
* The helper function to determine the title of the modal form or button based on the action or type
|
|
330
|
+
* @param actionOrType - The crud action or modal form type
|
|
331
|
+
*/
|
|
332
|
+
getTitleBasedOnActionOrType(actionOrType: CrudAction | ModalFormType): string;
|
|
333
|
+
/**
|
|
334
|
+
* Getter for the title of the modal form
|
|
335
|
+
*/
|
|
336
|
+
get modalFormTitle(): string;
|
|
319
337
|
/**
|
|
320
338
|
* Determines whether the button edit should be hidden in the column
|
|
321
339
|
*/
|
|
@@ -406,10 +424,10 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
406
424
|
*/
|
|
407
425
|
emitCrud(action: 'create' | 'edit' | 'delete'): void;
|
|
408
426
|
/**
|
|
409
|
-
* Show notifications
|
|
427
|
+
* Show notifications after CRUD operations (success or failure).
|
|
410
428
|
* @internal
|
|
411
429
|
*/
|
|
412
|
-
|
|
430
|
+
handleNotify(type: ModalFormType | CrudAction.Delete, requestError?: MessageError[]): void;
|
|
413
431
|
/**
|
|
414
432
|
* Clear the selected entity
|
|
415
433
|
* @internal
|
|
@@ -421,6 +439,10 @@ export declare class EntityManagement extends EntityManagement_base {
|
|
|
421
439
|
* @internal
|
|
422
440
|
*/
|
|
423
441
|
private generateCrudActionsMenu;
|
|
442
|
+
/**
|
|
443
|
+
* The event handler for when the selection changes in the grid.
|
|
444
|
+
*/
|
|
445
|
+
selectionChanged(event: CustomEvent<SelectionChangedEvent>): void;
|
|
424
446
|
}
|
|
425
447
|
|
|
426
448
|
declare const EntityManagement_base: (new (...args: any[]) => {
|
|
@@ -439,11 +461,7 @@ declare const EntityManagement_base: (new (...args: any[]) => {
|
|
|
439
461
|
readonly $fastController: Controller;
|
|
440
462
|
$emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
|
|
441
463
|
disconnectedCallback(): void;
|
|
442
|
-
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
443
|
-
* This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.
|
|
444
|
-
* @remarks Defaults to single
|
|
445
|
-
* @public
|
|
446
|
-
*/
|
|
464
|
+
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
447
465
|
accessKey: string;
|
|
448
466
|
readonly accessKeyLabel: string;
|
|
449
467
|
autocapitalize: string;
|
|
@@ -461,10 +479,6 @@ declare const EntityManagement_base: (new (...args: any[]) => {
|
|
|
461
479
|
outerText: string;
|
|
462
480
|
spellcheck: boolean;
|
|
463
481
|
title: string;
|
|
464
|
-
/**
|
|
465
|
-
* If true, will enable row flashing for all rows for `add` transactions
|
|
466
|
-
* @public
|
|
467
|
-
*/
|
|
468
482
|
translate: boolean;
|
|
469
483
|
attachInternals(): ElementInternals;
|
|
470
484
|
click(): void;
|
|
@@ -681,7 +695,12 @@ declare const EntityManagement_base: (new (...args: any[]) => {
|
|
|
681
695
|
ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
682
696
|
ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
683
697
|
ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
684
|
-
ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
698
|
+
ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any; /**
|
|
699
|
+
* Opens the model to edit an entity. Added as an event listener on the class when receiving the `edit-entity` event.
|
|
700
|
+
*
|
|
701
|
+
* @param e - CustomEvent where `e.detail` is the entity to edit.
|
|
702
|
+
* @internal
|
|
703
|
+
*/
|
|
685
704
|
ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
686
705
|
onemptied: (this: GlobalEventHandlers, ev: Event) => any;
|
|
687
706
|
onended: (this: GlobalEventHandlers, ev: Event) => any;
|
|
@@ -822,6 +841,12 @@ declare class MainRouterConfig extends RouterConfiguration<RouterSettings> {
|
|
|
822
841
|
*/
|
|
823
842
|
export declare const MainTemplate: ViewTemplate<MainApplication>;
|
|
824
843
|
|
|
844
|
+
declare enum ModalFormType {
|
|
845
|
+
Create = "create",
|
|
846
|
+
Read = "read",
|
|
847
|
+
Update = "update"
|
|
848
|
+
}
|
|
849
|
+
|
|
825
850
|
/**
|
|
826
851
|
* Main class which defined the profile management functionality
|
|
827
852
|
*
|
|
@@ -0,0 +1,24 @@
|
|
|
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) > [getTitleBasedOnActionOrType](./foundation-entity-management.entitymanagement.gettitlebasedonactionortype.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.getTitleBasedOnActionOrType() method
|
|
6
|
+
|
|
7
|
+
The helper function to determine the title of the modal form or button based on the action or type
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getTitleBasedOnActionOrType(actionOrType: CrudAction | ModalFormType): string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| actionOrType | CrudAction \| ModalFormType | The crud action or modal form type |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
string
|
|
24
|
+
|
|
@@ -51,7 +51,6 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
51
51
|
| [datasourceType](./foundation-entity-management.entitymanagement.datasourcetype.md) | | DatasourceType | If set to 'server' it will enable Server-Side Row Model and use <code>grid-pro-server-side-datasource</code> for the grid of the <code>entity-list</code> sub-component. By default <code>grid-pro-client-side-datasource</code> will be used. |
|
|
52
52
|
| [defaultEntityValues](./foundation-entity-management.entitymanagement.defaultentityvalues.md) | | Record<string, unknown> | The default values to populate the form with when the user is adding an entity |
|
|
53
53
|
| [deleteEvent](./foundation-entity-management.entitymanagement.deleteevent.md) | | string | Name of the event handler on the Genesis server which handles deleting the entity |
|
|
54
|
-
| [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 |
|
|
55
54
|
| [editedEntity](./foundation-entity-management.entitymanagement.editedentity.md) | | Record<string, unknown> | Disables the form while enabled to stop the user dispatching a large number of duplicate events |
|
|
56
55
|
| [editEntityModal](./foundation-entity-management.entitymanagement.editentitymodal.md) | | Modal | |
|
|
57
56
|
| [editModalVisible](./foundation-entity-management.entitymanagement.editmodalvisible.md) | | boolean | |
|
|
@@ -69,6 +68,8 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
69
68
|
| [hideDelete](./foundation-entity-management.entitymanagement.hidedelete.md) | | boolean | |
|
|
70
69
|
| [hideEdit](./foundation-entity-management.entitymanagement.hideedit.md) | | boolean | |
|
|
71
70
|
| [isServerSideDatasource](./foundation-entity-management.entitymanagement.isserversidedatasource.md) | <code>readonly</code> | boolean | |
|
|
71
|
+
| [modalFormTitle](./foundation-entity-management.entitymanagement.modalformtitle.md) | <code>readonly</code> | string | Getter for the title of the modal form |
|
|
72
|
+
| [modalFormType](./foundation-entity-management.entitymanagement.modalformtype.md) | | ModalFormType | The type of form that is currently being displayed in the modal |
|
|
72
73
|
| [modalPosition](./foundation-entity-management.entitymanagement.modalposition.md) | | 'centre' \| 'left' \| 'right' | Determines where the modal dialog will appear on screen |
|
|
73
74
|
| [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. |
|
|
74
75
|
| [prefix](./foundation-entity-management.entitymanagement.prefix.md) | | string | Name of the design system prefix that will be used in renderers. |
|
|
@@ -98,11 +99,13 @@ Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the na
|
|
|
98
99
|
| [disconnectedCallback()](./foundation-entity-management.entitymanagement.disconnectedcallback.md) | | |
|
|
99
100
|
| [editModalVisibleChanged()](./foundation-entity-management.entitymanagement.editmodalvisiblechanged.md) | | |
|
|
100
101
|
| [emitCrud(action)](./foundation-entity-management.entitymanagement.emitcrud.md) | | Emit the CRUD event for the selected entity |
|
|
102
|
+
| [getTitleBasedOnActionOrType(actionOrType)](./foundation-entity-management.entitymanagement.gettitlebasedonactionortype.md) | | The helper function to determine the title of the modal form or button based on the action or type |
|
|
101
103
|
| [hasContentInSlot(slotName)](./foundation-entity-management.entitymanagement.hascontentinslot.md) | | Checks if a slot contains any content. |
|
|
102
104
|
| [requestChanged(e)](./foundation-entity-management.entitymanagement.requestchanged.md) | | |
|
|
103
105
|
| [searchBarDataserver(options)](./foundation-entity-management.entitymanagement.searchbardataserver.md) | | |
|
|
104
106
|
| [searchBarReqServer(options)](./foundation-entity-management.entitymanagement.searchbarreqserver.md) | | |
|
|
105
107
|
| [searchChanged(event)](./foundation-entity-management.entitymanagement.searchchanged.md) | | |
|
|
108
|
+
| [selectionChanged(event)](./foundation-entity-management.entitymanagement.selectionchanged.md) | | The event handler for when the selection changes in the grid. |
|
|
106
109
|
| [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 |
|
|
107
110
|
| [submitFailureNotification(e)](./foundation-entity-management.entitymanagement.submitfailurenotification.md) | | |
|
|
108
111
|
|
|
@@ -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) > [modalFormTitle](./foundation-entity-management.entitymanagement.modalformtitle.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.modalFormTitle property
|
|
6
|
+
|
|
7
|
+
Getter for the title of the modal form
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
get modalFormTitle(): string;
|
|
13
|
+
```
|
|
@@ -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) > [modalFormType](./foundation-entity-management.entitymanagement.modalformtype.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.modalFormType property
|
|
6
|
+
|
|
7
|
+
The type of form that is currently being displayed in the modal
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
modalFormType: ModalFormType;
|
|
13
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
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) > [selectionChanged](./foundation-entity-management.entitymanagement.selectionchanged.md)
|
|
4
|
+
|
|
5
|
+
## EntityManagement.selectionChanged() method
|
|
6
|
+
|
|
7
|
+
The event handler for when the selection changes in the grid.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
selectionChanged(event: CustomEvent<SelectionChangedEvent>): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| event | CustomEvent<SelectionChangedEvent> | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
void
|
|
24
|
+
|
package/docs/api-report.md
CHANGED
|
@@ -24,11 +24,13 @@ import type { GridProCaseType } from '@genesislcap/grid-pro';
|
|
|
24
24
|
import { GridProRendererTypes } from '@genesislcap/foundation-zero-grid-pro';
|
|
25
25
|
import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
|
|
26
26
|
import { Logger } from '@genesislcap/foundation-logger';
|
|
27
|
-
import
|
|
27
|
+
import { MessageError } from '@genesislcap/foundation-comms';
|
|
28
|
+
import { Modal } from '@genesislcap/foundation-ui';
|
|
28
29
|
import { PartialFASTElementDefinition } from '@microsoft/fast-element';
|
|
29
30
|
import { RendererEntry } from '@genesislcap/foundation-forms';
|
|
30
31
|
import { RouterConfiguration } from '@microsoft/fast-router';
|
|
31
32
|
import { SelectedOption } from '@genesislcap/foundation-ui';
|
|
33
|
+
import { SelectionChangedEvent } from '@ag-grid-community/core';
|
|
32
34
|
import { Session } from '@genesislcap/foundation-comms';
|
|
33
35
|
import { UiSchema } from '@genesislcap/foundation-forms';
|
|
34
36
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
@@ -81,7 +83,6 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
81
83
|
deleteEvent: string;
|
|
82
84
|
// (undocumented)
|
|
83
85
|
disconnectedCallback(): Promise<void>;
|
|
84
|
-
editDialogTitle: string;
|
|
85
86
|
editedEntity: Record<string, unknown>;
|
|
86
87
|
// @internal
|
|
87
88
|
editEntity({ detail }: CustomEvent): Promise<void>;
|
|
@@ -98,14 +99,16 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
98
99
|
enableRowFlashing: boolean;
|
|
99
100
|
enableSearchBar: boolean;
|
|
100
101
|
entityLabel: string;
|
|
101
|
-
// @internal
|
|
102
|
-
errorNotify(request: any): void;
|
|
103
102
|
formRenderers: RendererEntry[];
|
|
104
103
|
// @internal
|
|
105
104
|
formResourceName: string;
|
|
106
105
|
// (undocumented)
|
|
107
106
|
formUiSchema: UiSchema;
|
|
107
|
+
// Warning: (ae-forgotten-export) The symbol "CrudAction" needs to be exported by the entry point index.d.ts
|
|
108
|
+
getTitleBasedOnActionOrType(actionOrType: CrudAction | ModalFormType): string;
|
|
108
109
|
gridOptions: GridOptions;
|
|
110
|
+
// @internal
|
|
111
|
+
handleNotify(type: ModalFormType | CrudAction.Delete, requestError?: MessageError[]): void;
|
|
109
112
|
hasContentInSlot(slotName: string): boolean;
|
|
110
113
|
get hasSelectedEntity(): boolean;
|
|
111
114
|
headerCaseType: GridProCaseType;
|
|
@@ -117,6 +120,9 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
117
120
|
hideEdit: boolean;
|
|
118
121
|
// (undocumented)
|
|
119
122
|
get isServerSideDatasource(): boolean;
|
|
123
|
+
get modalFormTitle(): string;
|
|
124
|
+
// Warning: (ae-forgotten-export) The symbol "ModalFormType" needs to be exported by the entry point index.d.ts
|
|
125
|
+
modalFormType: ModalFormType;
|
|
120
126
|
modalPosition: 'centre' | 'left' | 'right';
|
|
121
127
|
persistColumnStateKey: string;
|
|
122
128
|
prefix: string;
|
|
@@ -139,6 +145,7 @@ export class EntityManagement extends EntityManagement_base {
|
|
|
139
145
|
// (undocumented)
|
|
140
146
|
searchChanged(event: CustomEvent<Array<SelectedOption>>): void;
|
|
141
147
|
selectedEntity: Record<string, unknown>;
|
|
148
|
+
selectionChanged(event: CustomEvent<SelectionChangedEvent>): void;
|
|
142
149
|
get shouldHideDeleteInColumn(): boolean;
|
|
143
150
|
get shouldHideEditInColumn(): boolean;
|
|
144
151
|
// (undocumented)
|
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.203.
|
|
4
|
+
"version": "14.203.2",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -52,29 +52,29 @@
|
|
|
52
52
|
}
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"@genesislcap/foundation-testing": "14.203.
|
|
56
|
-
"@genesislcap/genx": "14.203.
|
|
57
|
-
"@genesislcap/rollup-builder": "14.203.
|
|
58
|
-
"@genesislcap/ts-builder": "14.203.
|
|
59
|
-
"@genesislcap/uvu-playwright-builder": "14.203.
|
|
60
|
-
"@genesislcap/vite-builder": "14.203.
|
|
61
|
-
"@genesislcap/webpack-builder": "14.203.
|
|
55
|
+
"@genesislcap/foundation-testing": "14.203.2",
|
|
56
|
+
"@genesislcap/genx": "14.203.2",
|
|
57
|
+
"@genesislcap/rollup-builder": "14.203.2",
|
|
58
|
+
"@genesislcap/ts-builder": "14.203.2",
|
|
59
|
+
"@genesislcap/uvu-playwright-builder": "14.203.2",
|
|
60
|
+
"@genesislcap/vite-builder": "14.203.2",
|
|
61
|
+
"@genesislcap/webpack-builder": "14.203.2",
|
|
62
62
|
"rimraf": "^5.0.0"
|
|
63
63
|
},
|
|
64
64
|
"dependencies": {
|
|
65
65
|
"@ag-grid-community/core": "29.2.0",
|
|
66
|
-
"@genesislcap/foundation-comms": "14.203.
|
|
67
|
-
"@genesislcap/foundation-errors": "14.203.
|
|
68
|
-
"@genesislcap/foundation-events": "14.203.
|
|
69
|
-
"@genesislcap/foundation-forms": "14.203.
|
|
70
|
-
"@genesislcap/foundation-logger": "14.203.
|
|
71
|
-
"@genesislcap/foundation-login": "14.203.
|
|
72
|
-
"@genesislcap/foundation-notifications": "14.203.
|
|
73
|
-
"@genesislcap/foundation-ui": "14.203.
|
|
74
|
-
"@genesislcap/foundation-utils": "14.203.
|
|
75
|
-
"@genesislcap/foundation-zero": "14.203.
|
|
76
|
-
"@genesislcap/foundation-zero-grid-pro": "14.203.
|
|
77
|
-
"@genesislcap/grid-pro": "14.203.
|
|
66
|
+
"@genesislcap/foundation-comms": "14.203.2",
|
|
67
|
+
"@genesislcap/foundation-errors": "14.203.2",
|
|
68
|
+
"@genesislcap/foundation-events": "14.203.2",
|
|
69
|
+
"@genesislcap/foundation-forms": "14.203.2",
|
|
70
|
+
"@genesislcap/foundation-logger": "14.203.2",
|
|
71
|
+
"@genesislcap/foundation-login": "14.203.2",
|
|
72
|
+
"@genesislcap/foundation-notifications": "14.203.2",
|
|
73
|
+
"@genesislcap/foundation-ui": "14.203.2",
|
|
74
|
+
"@genesislcap/foundation-utils": "14.203.2",
|
|
75
|
+
"@genesislcap/foundation-zero": "14.203.2",
|
|
76
|
+
"@genesislcap/foundation-zero-grid-pro": "14.203.2",
|
|
77
|
+
"@genesislcap/grid-pro": "14.203.2",
|
|
78
78
|
"@microsoft/fast-components": "^2.30.6",
|
|
79
79
|
"@microsoft/fast-element": "^1.12.0",
|
|
80
80
|
"@microsoft/fast-foundation": "^2.49.4",
|
|
@@ -90,5 +90,5 @@
|
|
|
90
90
|
"access": "public"
|
|
91
91
|
},
|
|
92
92
|
"customElements": "dist/custom-elements.json",
|
|
93
|
-
"gitHead": "
|
|
93
|
+
"gitHead": "8a31c5b68f7b0eecff3e23762c63c3d869ae25bb"
|
|
94
94
|
}
|