@genesislcap/foundation-entity-management 14.214.0 → 14.214.1-FUI-2233.1

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 (55) hide show
  1. package/dist/custom-elements.json +184 -834
  2. package/dist/dts/entities/entities.d.ts +132 -32
  3. package/dist/dts/entities/entities.d.ts.map +1 -1
  4. package/dist/esm/entities/entities.js +44 -10
  5. package/dist/esm/entities/entities.template.js +1 -1
  6. package/dist/foundation-entity-management.api.json +243 -1613
  7. package/dist/foundation-entity-management.d.ts +132 -32
  8. package/docs/api/foundation-entity-management.entitymanagement.createformuischema.md +2 -0
  9. package/docs/api/foundation-entity-management.entitymanagement.enablefilterbar.md +2 -0
  10. package/docs/api/foundation-entity-management.entitymanagement.entitylabel.md +1 -1
  11. package/docs/api/foundation-entity-management.entitymanagement.hidedelete.md +2 -0
  12. package/docs/api/foundation-entity-management.entitymanagement.hideedit.md +2 -0
  13. package/docs/api/foundation-entity-management.entitymanagement.md +10 -50
  14. package/docs/api/foundation-entity-management.entitymanagement.readevent.md +2 -0
  15. package/docs/api/foundation-entity-management.entitymanagement.readeventfn.md +3 -1
  16. package/docs/api/foundation-entity-management.entitymanagement.searchbarconfig.md +2 -0
  17. package/docs/api/foundation-entity-management.entitymanagement.sizecolumnstofit.md +2 -0
  18. package/docs/api/foundation-entity-management.entitymanagement.updateformuischema.md +2 -0
  19. package/docs/api-report.md +33 -34
  20. package/package.json +21 -21
  21. package/docs/api/foundation-entity-management.entitymanagement.asyncadd.md +0 -18
  22. package/docs/api/foundation-entity-management.entitymanagement.asyncremove.md +0 -18
  23. package/docs/api/foundation-entity-management.entitymanagement.asyncupdate.md +0 -18
  24. package/docs/api/foundation-entity-management.entitymanagement.closemodal.md +0 -15
  25. package/docs/api/foundation-entity-management.entitymanagement.confirmdelete.md +0 -15
  26. package/docs/api/foundation-entity-management.entitymanagement.connect.md +0 -18
  27. package/docs/api/foundation-entity-management.entitymanagement.criteriachanged.md +0 -22
  28. package/docs/api/foundation-entity-management.entitymanagement.crudmenuwrapper.md +0 -13
  29. package/docs/api/foundation-entity-management.entitymanagement.deepclone.md +0 -17
  30. package/docs/api/foundation-entity-management.entitymanagement.disconnectedcallback.md +0 -15
  31. package/docs/api/foundation-entity-management.entitymanagement.editedentity.md +0 -13
  32. package/docs/api/foundation-entity-management.entitymanagement.editentitymodal.md +0 -11
  33. package/docs/api/foundation-entity-management.entitymanagement.editmodalvisible.md +0 -11
  34. package/docs/api/foundation-entity-management.entitymanagement.editmodalvisiblechanged.md +0 -15
  35. package/docs/api/foundation-entity-management.entitymanagement.emitcrud.md +0 -24
  36. package/docs/api/foundation-entity-management.entitymanagement.formuischema.md +0 -11
  37. package/docs/api/foundation-entity-management.entitymanagement.gettitlebasedonactionortype.md +0 -24
  38. package/docs/api/foundation-entity-management.entitymanagement.hascontentinslot.md +0 -26
  39. package/docs/api/foundation-entity-management.entitymanagement.hasselectedentity.md +0 -13
  40. package/docs/api/foundation-entity-management.entitymanagement.headertempalate.md +0 -11
  41. package/docs/api/foundation-entity-management.entitymanagement.isserversidedatasource.md +0 -11
  42. package/docs/api/foundation-entity-management.entitymanagement.modalformtitle.md +0 -13
  43. package/docs/api/foundation-entity-management.entitymanagement.modalformtype.md +0 -13
  44. package/docs/api/foundation-entity-management.entitymanagement.readonly.md +0 -11
  45. package/docs/api/foundation-entity-management.entitymanagement.requestchanged.md +0 -22
  46. package/docs/api/foundation-entity-management.entitymanagement.searchbardataserver.md +0 -22
  47. package/docs/api/foundation-entity-management.entitymanagement.searchbarreqserver.md +0 -22
  48. package/docs/api/foundation-entity-management.entitymanagement.searchchanged.md +0 -22
  49. package/docs/api/foundation-entity-management.entitymanagement.selectedentity.md +0 -18
  50. package/docs/api/foundation-entity-management.entitymanagement.selectionchanged.md +0 -24
  51. package/docs/api/foundation-entity-management.entitymanagement.shouldhidedeleteincolumn.md +0 -13
  52. package/docs/api/foundation-entity-management.entitymanagement.shouldhideeditincolumn.md +0 -13
  53. package/docs/api/foundation-entity-management.entitymanagement.submitentitychanges.md +0 -24
  54. package/docs/api/foundation-entity-management.entitymanagement.submitfailurenotification.md +0 -22
  55. package/docs/api/foundation-entity-management.entitymanagement.submitting.md +0 -11
package/dist/custom-elements.json CHANGED
@@ -203,15 +203,6 @@
203
203
  "description": "Main class which defines the entity management functionality",
204
204
  "name": "EntityManagement",
205
205
  "members": [
206
- {
207
- "kind": "field",
208
- "name": "connect",
209
- "type": {
210
- "text": "Connect"
211
- },
212
- "privacy": "protected",
213
- "description": "DI connect object which is used to interact with the backend."
214
- },
215
206
  {
216
207
  "kind": "field",
217
208
  "name": "prefix",
@@ -236,21 +227,29 @@
236
227
  "name": "readEvent",
237
228
  "type": {
238
229
  "text": "string"
239
- }
230
+ },
231
+ "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity",
232
+ "privacy": "public"
240
233
  },
241
234
  {
242
235
  "kind": "field",
243
236
  "name": "readEventFn",
244
237
  "type": {
245
- "text": "(...args) => {}"
246
- }
247
- },
248
- {
249
- "kind": "field",
250
- "name": "readonly",
251
- "type": {
252
- "text": "boolean"
253
- }
238
+ "text": "(entity) => any"
239
+ },
240
+ "description": "Similar to readEvent but allows to provide function that will be executed before\nopening the form and yields data to the form",
241
+ "parameters": [
242
+ {
243
+ "description": "selected entity from the grid",
244
+ "name": "entity"
245
+ }
246
+ ],
247
+ "return": {
248
+ "type": {
249
+ "text": ""
250
+ }
251
+ },
252
+ "privacy": "public"
254
253
  },
255
254
  {
256
255
  "kind": "field",
@@ -294,37 +293,7 @@
294
293
  "type": {
295
294
  "text": "string"
296
295
  },
297
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
298
- "privacy": "public"
299
- },
300
- {
301
- "kind": "field",
302
- "name": "asyncAdd",
303
- "type": {
304
- "text": "boolean"
305
- },
306
- "default": "false",
307
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
308
- "privacy": "public"
309
- },
310
- {
311
- "kind": "field",
312
- "name": "asyncRemove",
313
- "type": {
314
- "text": "boolean"
315
- },
316
- "default": "false",
317
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
318
- "privacy": "public"
319
- },
320
- {
321
- "kind": "field",
322
- "name": "asyncUpdate",
323
- "type": {
324
- "text": "boolean"
325
- },
326
- "default": "true",
327
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
296
+ "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
328
297
  "privacy": "public"
329
298
  },
330
299
  {
@@ -403,26 +372,23 @@
403
372
  "description": "The configuration which is used when interacting with the resource on the backend",
404
373
  "privacy": "public"
405
374
  },
406
- {
407
- "kind": "field",
408
- "name": "formUiSchema",
409
- "type": {
410
- "text": "UiSchema"
411
- }
412
- },
413
375
  {
414
376
  "kind": "field",
415
377
  "name": "createFormUiSchema",
416
378
  "type": {
417
379
  "text": "UiSchema"
418
- }
380
+ },
381
+ "description": "Enables you to supply a schema to configure an insert form.",
382
+ "privacy": "public"
419
383
  },
420
384
  {
421
385
  "kind": "field",
422
386
  "name": "updateFormUiSchema",
423
387
  "type": {
424
388
  "text": "UiSchema"
425
- }
389
+ },
390
+ "description": "Enables you to supply a schema to configure an update form.",
391
+ "privacy": "public"
426
392
  },
427
393
  {
428
394
  "kind": "field",
@@ -434,24 +400,6 @@
434
400
  "description": "Array with renderers used by foundation-forms",
435
401
  "privacy": "public"
436
402
  },
437
- {
438
- "kind": "field",
439
- "name": "selectedEntity",
440
- "type": {
441
- "text": "Record<string, unknown>"
442
- },
443
- "description": "Reference to the currently selected entity from the grid.",
444
- "privacy": "public"
445
- },
446
- {
447
- "kind": "field",
448
- "name": "editedEntity",
449
- "type": {
450
- "text": "Record<string, unknown>"
451
- },
452
- "description": "Disables the form while enabled to stop the user dispatching a large number of duplicate events",
453
- "privacy": "public"
454
- },
455
403
  {
456
404
  "kind": "field",
457
405
  "name": "defaultEntityValues",
@@ -461,54 +409,28 @@
461
409
  "description": "The default values to populate the form with when the user is adding an entity",
462
410
  "privacy": "public"
463
411
  },
464
- {
465
- "kind": "field",
466
- "name": "submitting",
467
- "type": {
468
- "text": "boolean"
469
- }
470
- },
471
- {
472
- "kind": "field",
473
- "name": "modalFormType",
474
- "type": {
475
- "text": "ModalFormType"
476
- },
477
- "description": "The type of form that is currently being displayed in the modal"
478
- },
479
- {
480
- "kind": "field",
481
- "name": "editModalVisible",
482
- "type": {
483
- "text": "boolean"
484
- },
485
- "default": "false"
486
- },
487
412
  {
488
413
  "kind": "method",
489
- "name": "editModalVisibleChanged"
490
- },
491
- {
492
- "kind": "field",
493
- "name": "editEntityModal",
494
- "type": {
495
- "text": "Modal"
496
- },
497
- "privacy": "public"
414
+ "name": "editModalVisibleChanged",
415
+ "privacy": "private"
498
416
  },
499
417
  {
500
418
  "kind": "field",
501
419
  "name": "sizeColumnsToFit",
502
420
  "type": {
503
421
  "text": "boolean"
504
- }
422
+ },
423
+ "description": "Resizes columns to take available space",
424
+ "privacy": "public"
505
425
  },
506
426
  {
507
427
  "kind": "field",
508
428
  "name": "enableFilterBar",
509
429
  "type": {
510
430
  "text": "boolean"
511
- }
431
+ },
432
+ "description": "Enables filter bar component",
433
+ "privacy": "public"
512
434
  },
513
435
  {
514
436
  "kind": "field",
@@ -516,7 +438,9 @@
516
438
  "type": {
517
439
  "text": "boolean"
518
440
  },
519
- "default": "false"
441
+ "default": "false",
442
+ "description": "Hides edit button",
443
+ "privacy": "public"
520
444
  },
521
445
  {
522
446
  "kind": "field",
@@ -524,7 +448,9 @@
524
448
  "type": {
525
449
  "text": "boolean"
526
450
  },
527
- "default": "false"
451
+ "default": "false",
452
+ "description": "Hides delete button",
453
+ "privacy": "public"
528
454
  },
529
455
  {
530
456
  "kind": "field",
@@ -550,7 +476,8 @@
550
476
  "name": "searchBarConfig",
551
477
  "type": {
552
478
  "text": "AvailableOption[]"
553
- }
479
+ },
480
+ "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @public"
554
481
  },
555
482
  {
556
483
  "kind": "field",
@@ -589,106 +516,6 @@
589
516
  "default": "'⋮'",
590
517
  "description": "The label of the crud action menu"
591
518
  },
592
- {
593
- "kind": "field",
594
- "name": "crudMenuWrapper",
595
- "privacy": "public",
596
- "description": "The Id of the crud buttons wrapper element"
597
- },
598
- {
599
- "kind": "method",
600
- "name": "getTitleBasedOnActionOrType",
601
- "privacy": "public",
602
- "parameters": [
603
- {
604
- "name": "actionOrType",
605
- "type": {
606
- "text": "CrudAction | ModalFormType"
607
- },
608
- "description": "The crud action or modal form type"
609
- }
610
- ],
611
- "description": "The helper function to determine the title of the modal form or button based on the action or type"
612
- },
613
- {
614
- "kind": "field",
615
- "name": "modalFormTitle",
616
- "description": "Getter for the title of the modal form",
617
- "readonly": true
618
- },
619
- {
620
- "kind": "field",
621
- "name": "shouldHideEditInColumn",
622
- "type": {
623
- "text": "boolean"
624
- },
625
- "description": "Determines whether the button edit should be hidden in the column",
626
- "readonly": true
627
- },
628
- {
629
- "kind": "field",
630
- "name": "shouldHideDeleteInColumn",
631
- "type": {
632
- "text": "boolean"
633
- },
634
- "description": "Determines whether the button delete should be hidden in the column",
635
- "readonly": true
636
- },
637
- {
638
- "kind": "field",
639
- "name": "hasSelectedEntity",
640
- "type": {
641
- "text": "boolean"
642
- },
643
- "description": "Determines whether there is a selected entity",
644
- "readonly": true
645
- },
646
- {
647
- "kind": "method",
648
- "name": "hasContentInSlot",
649
- "privacy": "public",
650
- "return": {
651
- "type": {
652
- "text": ""
653
- }
654
- },
655
- "parameters": [
656
- {
657
- "name": "slotName",
658
- "type": {
659
- "text": "string"
660
- },
661
- "description": "The name of the slot to check."
662
- }
663
- ],
664
- "description": "Checks if a slot contains any content."
665
- },
666
- {
667
- "kind": "method",
668
- "name": "deepClone",
669
- "return": {
670
- "type": {
671
- "text": "Node"
672
- }
673
- },
674
- "description": "Override the deepClone method to ensure that observable attributes are cloned",
675
- "privacy": "public"
676
- },
677
- {
678
- "kind": "method",
679
- "name": "submitEntityChanges",
680
- "privacy": "public",
681
- "parameters": [
682
- {
683
- "name": "e",
684
- "type": {
685
- "text": "CustomEvent"
686
- },
687
- "description": "CustomEvent which contains the payload for the entity to submit to the backend\n\nEmits an event upon error"
688
- }
689
- ],
690
- "description": "Event handler for when the user submits the action for the currently open form, either editing or adding the entity"
691
- },
692
519
  {
693
520
  "kind": "method",
694
521
  "name": "readEntity",
@@ -702,40 +529,10 @@
702
529
  }
703
530
  ]
704
531
  },
705
- {
706
- "kind": "method",
707
- "name": "closeModal",
708
- "privacy": "public"
709
- },
710
- {
711
- "kind": "field",
712
- "name": "headerTempalate",
713
- "readonly": true
714
- },
715
- {
716
- "kind": "field",
717
- "name": "isServerSideDatasource",
718
- "type": {
719
- "text": "boolean"
720
- },
721
- "readonly": true
722
- },
723
- {
724
- "kind": "method",
725
- "name": "searchChanged",
726
- "privacy": "public",
727
- "parameters": [
728
- {
729
- "name": "event",
730
- "type": {
731
- "text": "CustomEvent<Array<SelectedOption>>"
732
- }
733
- }
734
- ]
735
- },
736
532
  {
737
533
  "kind": "method",
738
534
  "name": "searchBarReqServer",
535
+ "privacy": "private",
739
536
  "parameters": [
740
537
  {
741
538
  "name": "options",
@@ -748,6 +545,7 @@
748
545
  {
749
546
  "kind": "method",
750
547
  "name": "searchBarDataserver",
548
+ "privacy": "private",
751
549
  "parameters": [
752
550
  {
753
551
  "name": "options",
@@ -760,7 +558,7 @@
760
558
  {
761
559
  "kind": "method",
762
560
  "name": "requestChanged",
763
- "privacy": "public",
561
+ "privacy": "private",
764
562
  "parameters": [
765
563
  {
766
564
  "name": "e",
@@ -773,7 +571,7 @@
773
571
  {
774
572
  "kind": "method",
775
573
  "name": "criteriaChanged",
776
- "privacy": "public",
574
+ "privacy": "private",
777
575
  "parameters": [
778
576
  {
779
577
  "name": "e",
@@ -786,7 +584,7 @@
786
584
  {
787
585
  "kind": "method",
788
586
  "name": "submitFailureNotification",
789
- "privacy": "public",
587
+ "privacy": "private",
790
588
  "parameters": [
791
589
  {
792
590
  "name": "e",
@@ -809,43 +607,10 @@
809
607
  }
810
608
  ]
811
609
  },
812
- {
813
- "kind": "method",
814
- "name": "confirmDelete"
815
- },
816
610
  {
817
611
  "kind": "method",
818
612
  "name": "showDeleteConfirmation",
819
613
  "privacy": "private"
820
- },
821
- {
822
- "kind": "method",
823
- "name": "emitCrud",
824
- "privacy": "public",
825
- "parameters": [
826
- {
827
- "name": "action",
828
- "type": {
829
- "text": "'create' | 'edit' | 'delete'"
830
- },
831
- "description": "the action to emit"
832
- }
833
- ],
834
- "description": "Emit the CRUD event for the selected entity"
835
- },
836
- {
837
- "kind": "method",
838
- "name": "selectionChanged",
839
- "privacy": "public",
840
- "parameters": [
841
- {
842
- "name": "event",
843
- "type": {
844
- "text": "CustomEvent<SelectionChangedEvent>"
845
- }
846
- }
847
- ],
848
- "description": "The event handler for when the selection changes in the grid."
849
614
  }
850
615
  ],
851
616
  "attributes": [
@@ -871,16 +636,11 @@
871
636
  "type": {
872
637
  "text": "string"
873
638
  },
639
+ "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity",
874
640
  "fieldName": "readEvent"
875
641
  },
876
642
  {
877
- "type": {
878
- "text": "boolean"
879
- },
880
- "fieldName": "readonly"
881
- },
882
- {
883
- "name": "updateEvent",
643
+ "name": "updateEvent",
884
644
  "type": {
885
645
  "text": "string"
886
646
  },
@@ -916,36 +676,9 @@
916
676
  "type": {
917
677
  "text": "string"
918
678
  },
919
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
679
+ "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
920
680
  "fieldName": "entityLabel"
921
681
  },
922
- {
923
- "name": "async-add",
924
- "type": {
925
- "text": "boolean"
926
- },
927
- "default": "false",
928
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
929
- "fieldName": "asyncAdd"
930
- },
931
- {
932
- "name": "async-remove",
933
- "type": {
934
- "text": "boolean"
935
- },
936
- "default": "false",
937
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
938
- "fieldName": "asyncRemove"
939
- },
940
- {
941
- "name": "async-update",
942
- "type": {
943
- "text": "boolean"
944
- },
945
- "default": "true",
946
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
947
- "fieldName": "asyncUpdate"
948
- },
949
682
  {
950
683
  "name": "row-selection",
951
684
  "type": {
@@ -995,6 +728,7 @@
995
728
  "type": {
996
729
  "text": "boolean"
997
730
  },
731
+ "description": "Resizes columns to take available space",
998
732
  "fieldName": "sizeColumnsToFit"
999
733
  },
1000
734
  {
@@ -1002,6 +736,7 @@
1002
736
  "type": {
1003
737
  "text": "boolean"
1004
738
  },
739
+ "description": "Enables filter bar component",
1005
740
  "fieldName": "enableFilterBar"
1006
741
  },
1007
742
  {
@@ -1010,6 +745,7 @@
1010
745
  "text": "boolean"
1011
746
  },
1012
747
  "default": "false",
748
+ "description": "Hides edit button",
1013
749
  "fieldName": "hideEdit"
1014
750
  },
1015
751
  {
@@ -1018,6 +754,7 @@
1018
754
  "text": "boolean"
1019
755
  },
1020
756
  "default": "false",
757
+ "description": "Hides delete button",
1021
758
  "fieldName": "hideDelete"
1022
759
  },
1023
760
  {
@@ -1925,11 +1662,7 @@
1925
1662
  },
1926
1663
  {
1927
1664
  "kind": "method",
1928
- "name": "confirmDelete",
1929
- "inheritedFrom": {
1930
- "name": "EntityManagement",
1931
- "module": "src/entities/entities.ts"
1932
- }
1665
+ "name": "confirmDelete"
1933
1666
  },
1934
1667
  {
1935
1668
  "kind": "field",
@@ -1990,6 +1723,8 @@
1990
1723
  "type": {
1991
1724
  "text": "UiSchema"
1992
1725
  },
1726
+ "description": "Enables you to supply a schema to configure an update form.",
1727
+ "privacy": "public",
1993
1728
  "default": "editProfileFormSchema",
1994
1729
  "inheritedFrom": {
1995
1730
  "name": "EntityManagement",
@@ -2002,6 +1737,8 @@
2002
1737
  "type": {
2003
1738
  "text": "UiSchema"
2004
1739
  },
1740
+ "description": "Enables you to supply a schema to configure an insert form.",
1741
+ "privacy": "public",
2005
1742
  "default": "editProfileFormSchema",
2006
1743
  "inheritedFrom": {
2007
1744
  "name": "EntityManagement",
@@ -2012,8 +1749,21 @@
2012
1749
  "kind": "field",
2013
1750
  "name": "readEventFn",
2014
1751
  "type": {
2015
- "text": "(...args) => {}"
1752
+ "text": "(entity) => any"
2016
1753
  },
1754
+ "description": "Similar to readEvent but allows to provide function that will be executed before\nopening the form and yields data to the form",
1755
+ "parameters": [
1756
+ {
1757
+ "description": "selected entity from the grid",
1758
+ "name": "entity"
1759
+ }
1760
+ ],
1761
+ "return": {
1762
+ "type": {
1763
+ "text": ""
1764
+ }
1765
+ },
1766
+ "privacy": "public",
2017
1767
  "inheritedFrom": {
2018
1768
  "name": "EntityManagement",
2019
1769
  "module": "src/entities/entities.ts"
@@ -2053,7 +1803,7 @@
2053
1803
  "type": {
2054
1804
  "text": "string"
2055
1805
  },
2056
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
1806
+ "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
2057
1807
  "privacy": "public",
2058
1808
  "default": "'Profile'",
2059
1809
  "inheritedFrom": {
@@ -2061,19 +1811,6 @@
2061
1811
  "module": "src/entities/entities.ts"
2062
1812
  }
2063
1813
  },
2064
- {
2065
- "kind": "field",
2066
- "name": "connect",
2067
- "type": {
2068
- "text": "Connect"
2069
- },
2070
- "privacy": "protected",
2071
- "description": "DI connect object which is used to interact with the backend.",
2072
- "inheritedFrom": {
2073
- "name": "EntityManagement",
2074
- "module": "src/entities/entities.ts"
2075
- }
2076
- },
2077
1814
  {
2078
1815
  "kind": "field",
2079
1816
  "name": "prefix",
@@ -2090,299 +1827,12 @@
2090
1827
  },
2091
1828
  {
2092
1829
  "kind": "field",
2093
- "name": "readEvent",
2094
- "type": {
2095
- "text": "string"
2096
- },
2097
- "inheritedFrom": {
2098
- "name": "EntityManagement",
2099
- "module": "src/entities/entities.ts"
2100
- }
2101
- },
2102
- {
2103
- "kind": "field",
2104
- "name": "readonly",
2105
- "type": {
2106
- "text": "boolean"
2107
- },
2108
- "inheritedFrom": {
2109
- "name": "EntityManagement",
2110
- "module": "src/entities/entities.ts"
2111
- }
2112
- },
2113
- {
2114
- "kind": "field",
2115
- "name": "asyncAdd",
2116
- "type": {
2117
- "text": "boolean"
2118
- },
2119
- "default": "false",
2120
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
2121
- "privacy": "public",
2122
- "inheritedFrom": {
2123
- "name": "EntityManagement",
2124
- "module": "src/entities/entities.ts"
2125
- }
2126
- },
2127
- {
2128
- "kind": "field",
2129
- "name": "asyncRemove",
2130
- "type": {
2131
- "text": "boolean"
2132
- },
2133
- "default": "false",
2134
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
2135
- "privacy": "public",
2136
- "inheritedFrom": {
2137
- "name": "EntityManagement",
2138
- "module": "src/entities/entities.ts"
2139
- }
2140
- },
2141
- {
2142
- "kind": "field",
2143
- "name": "asyncUpdate",
2144
- "type": {
2145
- "text": "boolean"
2146
- },
2147
- "default": "true",
2148
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
2149
- "privacy": "public",
2150
- "inheritedFrom": {
2151
- "name": "EntityManagement",
2152
- "module": "src/entities/entities.ts"
2153
- }
2154
- },
2155
- {
2156
- "kind": "field",
2157
- "name": "rowSelection",
2158
- "type": {
2159
- "text": "string"
2160
- },
2161
- "default": "'single'",
2162
- "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.",
2163
- "privacy": "public",
2164
- "inheritedFrom": {
2165
- "name": "EntityManagement",
2166
- "module": "src/entities/entities.ts"
2167
- }
2168
- },
2169
- {
2170
- "kind": "field",
2171
- "name": "enableCellFlashing",
2172
- "type": {
2173
- "text": "boolean"
2174
- },
2175
- "default": "false",
2176
- "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
2177
- "privacy": "public",
2178
- "inheritedFrom": {
2179
- "name": "EntityManagement",
2180
- "module": "src/entities/entities.ts"
2181
- }
2182
- },
2183
- {
2184
- "kind": "field",
2185
- "name": "enableRowFlashing",
2186
- "type": {
2187
- "text": "boolean"
2188
- },
2189
- "default": "false",
2190
- "description": "If true, will enable row flashing for all rows for `add` transactions",
2191
- "privacy": "public",
2192
- "inheritedFrom": {
2193
- "name": "EntityManagement",
2194
- "module": "src/entities/entities.ts"
2195
- }
2196
- },
2197
- {
2198
- "kind": "field",
2199
- "name": "datasourceType",
2200
- "type": {
2201
- "text": "DatasourceType"
2202
- },
2203
- "default": "'client'",
2204
- "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
2205
- "privacy": "public",
2206
- "inheritedFrom": {
2207
- "name": "EntityManagement",
2208
- "module": "src/entities/entities.ts"
2209
- }
2210
- },
2211
- {
2212
- "kind": "field",
2213
- "name": "gridOptions",
2214
- "type": {
2215
- "text": "GridOptions"
2216
- },
2217
- "description": "GridOptions to be passed down from application",
2218
- "privacy": "public",
2219
- "inheritedFrom": {
2220
- "name": "EntityManagement",
2221
- "module": "src/entities/entities.ts"
2222
- }
2223
- },
2224
- {
2225
- "kind": "field",
2226
- "name": "columns",
2227
- "type": {
2228
- "text": "ColDef[]"
2229
- },
2230
- "description": "Array which holds the column definitions.",
2231
- "privacy": "public",
2232
- "inheritedFrom": {
2233
- "name": "EntityManagement",
2234
- "module": "src/entities/entities.ts"
2235
- }
2236
- },
2237
- {
2238
- "kind": "field",
2239
- "name": "datasourceConfig",
2240
- "type": {
2241
- "text": "DatasourceConfiguration"
2242
- },
2243
- "description": "The configuration which is used when interacting with the resource on the backend",
2244
- "privacy": "public",
2245
- "inheritedFrom": {
2246
- "name": "EntityManagement",
2247
- "module": "src/entities/entities.ts"
2248
- }
2249
- },
2250
- {
2251
- "kind": "field",
2252
- "name": "formUiSchema",
2253
- "type": {
2254
- "text": "UiSchema"
2255
- },
2256
- "inheritedFrom": {
2257
- "name": "EntityManagement",
2258
- "module": "src/entities/entities.ts"
2259
- }
2260
- },
2261
- {
2262
- "kind": "field",
2263
- "name": "formRenderers",
2264
- "type": {
2265
- "text": "RendererEntry[]"
2266
- },
2267
- "default": "renderers",
2268
- "description": "Array with renderers used by foundation-forms",
2269
- "privacy": "public",
2270
- "inheritedFrom": {
2271
- "name": "EntityManagement",
2272
- "module": "src/entities/entities.ts"
2273
- }
2274
- },
2275
- {
2276
- "kind": "field",
2277
- "name": "selectedEntity",
2278
- "type": {
2279
- "text": "Record<string, unknown>"
2280
- },
2281
- "description": "Reference to the currently selected entity from the grid.",
2282
- "privacy": "public",
2283
- "inheritedFrom": {
2284
- "name": "EntityManagement",
2285
- "module": "src/entities/entities.ts"
2286
- }
2287
- },
2288
- {
2289
- "kind": "field",
2290
- "name": "editedEntity",
2291
- "type": {
2292
- "text": "Record<string, unknown>"
2293
- },
2294
- "description": "Disables the form while enabled to stop the user dispatching a large number of duplicate events",
2295
- "privacy": "public",
2296
- "inheritedFrom": {
2297
- "name": "EntityManagement",
2298
- "module": "src/entities/entities.ts"
2299
- }
2300
- },
2301
- {
2302
- "kind": "field",
2303
- "name": "defaultEntityValues",
2304
- "type": {
2305
- "text": "Record<string, unknown>"
2306
- },
2307
- "description": "The default values to populate the form with when the user is adding an entity",
2308
- "privacy": "public",
2309
- "inheritedFrom": {
2310
- "name": "EntityManagement",
2311
- "module": "src/entities/entities.ts"
2312
- }
2313
- },
2314
- {
2315
- "kind": "field",
2316
- "name": "submitting",
2317
- "type": {
2318
- "text": "boolean"
2319
- },
2320
- "inheritedFrom": {
2321
- "name": "EntityManagement",
2322
- "module": "src/entities/entities.ts"
2323
- }
2324
- },
2325
- {
2326
- "kind": "field",
2327
- "name": "modalFormType",
2328
- "type": {
2329
- "text": "ModalFormType"
2330
- },
2331
- "description": "The type of form that is currently being displayed in the modal",
2332
- "inheritedFrom": {
2333
- "name": "EntityManagement",
2334
- "module": "src/entities/entities.ts"
2335
- }
2336
- },
2337
- {
2338
- "kind": "field",
2339
- "name": "editModalVisible",
2340
- "type": {
2341
- "text": "boolean"
2342
- },
2343
- "default": "false",
2344
- "inheritedFrom": {
2345
- "name": "EntityManagement",
2346
- "module": "src/entities/entities.ts"
2347
- }
2348
- },
2349
- {
2350
- "kind": "method",
2351
- "name": "editModalVisibleChanged",
2352
- "inheritedFrom": {
2353
- "name": "EntityManagement",
2354
- "module": "src/entities/entities.ts"
2355
- }
2356
- },
2357
- {
2358
- "kind": "field",
2359
- "name": "editEntityModal",
2360
- "type": {
2361
- "text": "Modal"
2362
- },
2363
- "privacy": "public",
2364
- "inheritedFrom": {
2365
- "name": "EntityManagement",
2366
- "module": "src/entities/entities.ts"
2367
- }
2368
- },
2369
- {
2370
- "kind": "field",
2371
- "name": "sizeColumnsToFit",
2372
- "type": {
2373
- "text": "boolean"
2374
- },
2375
- "inheritedFrom": {
2376
- "name": "EntityManagement",
2377
- "module": "src/entities/entities.ts"
2378
- }
2379
- },
2380
- {
2381
- "kind": "field",
2382
- "name": "enableFilterBar",
1830
+ "name": "readEvent",
2383
1831
  "type": {
2384
- "text": "boolean"
1832
+ "text": "string"
2385
1833
  },
1834
+ "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity",
1835
+ "privacy": "public",
2386
1836
  "inheritedFrom": {
2387
1837
  "name": "EntityManagement",
2388
1838
  "module": "src/entities/entities.ts"
@@ -2390,11 +1840,13 @@
2390
1840
  },
2391
1841
  {
2392
1842
  "kind": "field",
2393
- "name": "hideEdit",
1843
+ "name": "rowSelection",
2394
1844
  "type": {
2395
- "text": "boolean"
1845
+ "text": "string"
2396
1846
  },
2397
- "default": "false",
1847
+ "default": "'single'",
1848
+ "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.",
1849
+ "privacy": "public",
2398
1850
  "inheritedFrom": {
2399
1851
  "name": "EntityManagement",
2400
1852
  "module": "src/entities/entities.ts"
@@ -2402,11 +1854,13 @@
2402
1854
  },
2403
1855
  {
2404
1856
  "kind": "field",
2405
- "name": "hideDelete",
1857
+ "name": "enableCellFlashing",
2406
1858
  "type": {
2407
1859
  "text": "boolean"
2408
1860
  },
2409
1861
  "default": "false",
1862
+ "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
1863
+ "privacy": "public",
2410
1864
  "inheritedFrom": {
2411
1865
  "name": "EntityManagement",
2412
1866
  "module": "src/entities/entities.ts"
@@ -2414,12 +1868,12 @@
2414
1868
  },
2415
1869
  {
2416
1870
  "kind": "field",
2417
- "name": "enableSearchBar",
1871
+ "name": "enableRowFlashing",
2418
1872
  "type": {
2419
1873
  "text": "boolean"
2420
1874
  },
2421
1875
  "default": "false",
2422
- "description": "This attribute controls whether to enable the search-bar.",
1876
+ "description": "If true, will enable row flashing for all rows for `add` transactions",
2423
1877
  "privacy": "public",
2424
1878
  "inheritedFrom": {
2425
1879
  "name": "EntityManagement",
@@ -2428,11 +1882,12 @@
2428
1882
  },
2429
1883
  {
2430
1884
  "kind": "field",
2431
- "name": "headerCaseType",
1885
+ "name": "datasourceType",
2432
1886
  "type": {
2433
- "text": "GridProCaseType"
1887
+ "text": "DatasourceType"
2434
1888
  },
2435
- "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
1889
+ "default": "'client'",
1890
+ "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.",
2436
1891
  "privacy": "public",
2437
1892
  "inheritedFrom": {
2438
1893
  "name": "EntityManagement",
@@ -2441,10 +1896,12 @@
2441
1896
  },
2442
1897
  {
2443
1898
  "kind": "field",
2444
- "name": "searchBarConfig",
1899
+ "name": "gridOptions",
2445
1900
  "type": {
2446
- "text": "AvailableOption[]"
1901
+ "text": "GridOptions"
2447
1902
  },
1903
+ "description": "GridOptions to be passed down from application",
1904
+ "privacy": "public",
2448
1905
  "inheritedFrom": {
2449
1906
  "name": "EntityManagement",
2450
1907
  "module": "src/entities/entities.ts"
@@ -2452,12 +1909,11 @@
2452
1909
  },
2453
1910
  {
2454
1911
  "kind": "field",
2455
- "name": "modalPosition",
1912
+ "name": "columns",
2456
1913
  "type": {
2457
- "text": "'centre' | 'left' | 'right'"
1914
+ "text": "ColDef[]"
2458
1915
  },
2459
- "default": "'right'",
2460
- "description": "Determines where the modal dialog will appear on screen",
1916
+ "description": "Array which holds the column definitions.",
2461
1917
  "privacy": "public",
2462
1918
  "inheritedFrom": {
2463
1919
  "name": "EntityManagement",
@@ -2466,11 +1922,11 @@
2466
1922
  },
2467
1923
  {
2468
1924
  "kind": "field",
2469
- "name": "crudMenuPosition",
1925
+ "name": "datasourceConfig",
2470
1926
  "type": {
2471
- "text": "CrudMenuPosition"
1927
+ "text": "DatasourceConfiguration"
2472
1928
  },
2473
- "description": "Determines where the buttons will appear",
1929
+ "description": "The configuration which is used when interacting with the resource on the backend",
2474
1930
  "privacy": "public",
2475
1931
  "inheritedFrom": {
2476
1932
  "name": "EntityManagement",
@@ -2479,11 +1935,12 @@
2479
1935
  },
2480
1936
  {
2481
1937
  "kind": "field",
2482
- "name": "crudMenuStyle",
1938
+ "name": "formRenderers",
2483
1939
  "type": {
2484
- "text": "ActionsMenuStyle"
1940
+ "text": "RendererEntry[]"
2485
1941
  },
2486
- "description": "Determines the style of the buttons",
1942
+ "default": "renderers",
1943
+ "description": "Array with renderers used by foundation-forms",
2487
1944
  "privacy": "public",
2488
1945
  "inheritedFrom": {
2489
1946
  "name": "EntityManagement",
@@ -2492,22 +1949,12 @@
2492
1949
  },
2493
1950
  {
2494
1951
  "kind": "field",
2495
- "name": "crudActionMenuName",
1952
+ "name": "defaultEntityValues",
2496
1953
  "type": {
2497
- "text": "string"
1954
+ "text": "Record<string, unknown>"
2498
1955
  },
2499
- "default": "'⋮'",
2500
- "description": "The label of the crud action menu",
2501
- "inheritedFrom": {
2502
- "name": "EntityManagement",
2503
- "module": "src/entities/entities.ts"
2504
- }
2505
- },
2506
- {
2507
- "kind": "field",
2508
- "name": "crudMenuWrapper",
1956
+ "description": "The default values to populate the form with when the user is adding an entity",
2509
1957
  "privacy": "public",
2510
- "description": "The Id of the crud buttons wrapper element",
2511
1958
  "inheritedFrom": {
2512
1959
  "name": "EntityManagement",
2513
1960
  "module": "src/entities/entities.ts"
@@ -2515,18 +1962,8 @@
2515
1962
  },
2516
1963
  {
2517
1964
  "kind": "method",
2518
- "name": "getTitleBasedOnActionOrType",
2519
- "privacy": "public",
2520
- "parameters": [
2521
- {
2522
- "name": "actionOrType",
2523
- "type": {
2524
- "text": "CrudAction | ModalFormType"
2525
- },
2526
- "description": "The crud action or modal form type"
2527
- }
2528
- ],
2529
- "description": "The helper function to determine the title of the modal form or button based on the action or type",
1965
+ "name": "editModalVisibleChanged",
1966
+ "privacy": "private",
2530
1967
  "inheritedFrom": {
2531
1968
  "name": "EntityManagement",
2532
1969
  "module": "src/entities/entities.ts"
@@ -2534,9 +1971,12 @@
2534
1971
  },
2535
1972
  {
2536
1973
  "kind": "field",
2537
- "name": "modalFormTitle",
2538
- "description": "Getter for the title of the modal form",
2539
- "readonly": true,
1974
+ "name": "sizeColumnsToFit",
1975
+ "type": {
1976
+ "text": "boolean"
1977
+ },
1978
+ "description": "Resizes columns to take available space",
1979
+ "privacy": "public",
2540
1980
  "inheritedFrom": {
2541
1981
  "name": "EntityManagement",
2542
1982
  "module": "src/entities/entities.ts"
@@ -2544,12 +1984,12 @@
2544
1984
  },
2545
1985
  {
2546
1986
  "kind": "field",
2547
- "name": "shouldHideEditInColumn",
1987
+ "name": "enableFilterBar",
2548
1988
  "type": {
2549
1989
  "text": "boolean"
2550
1990
  },
2551
- "description": "Determines whether the button edit should be hidden in the column",
2552
- "readonly": true,
1991
+ "description": "Enables filter bar component",
1992
+ "privacy": "public",
2553
1993
  "inheritedFrom": {
2554
1994
  "name": "EntityManagement",
2555
1995
  "module": "src/entities/entities.ts"
@@ -2557,12 +1997,13 @@
2557
1997
  },
2558
1998
  {
2559
1999
  "kind": "field",
2560
- "name": "shouldHideDeleteInColumn",
2000
+ "name": "hideEdit",
2561
2001
  "type": {
2562
2002
  "text": "boolean"
2563
2003
  },
2564
- "description": "Determines whether the button delete should be hidden in the column",
2565
- "readonly": true,
2004
+ "default": "false",
2005
+ "description": "Hides edit button",
2006
+ "privacy": "public",
2566
2007
  "inheritedFrom": {
2567
2008
  "name": "EntityManagement",
2568
2009
  "module": "src/entities/entities.ts"
@@ -2570,50 +2011,39 @@
2570
2011
  },
2571
2012
  {
2572
2013
  "kind": "field",
2573
- "name": "hasSelectedEntity",
2014
+ "name": "hideDelete",
2574
2015
  "type": {
2575
2016
  "text": "boolean"
2576
2017
  },
2577
- "description": "Determines whether there is a selected entity",
2578
- "readonly": true,
2018
+ "default": "false",
2019
+ "description": "Hides delete button",
2020
+ "privacy": "public",
2579
2021
  "inheritedFrom": {
2580
2022
  "name": "EntityManagement",
2581
2023
  "module": "src/entities/entities.ts"
2582
2024
  }
2583
2025
  },
2584
2026
  {
2585
- "kind": "method",
2586
- "name": "hasContentInSlot",
2587
- "privacy": "public",
2588
- "return": {
2589
- "type": {
2590
- "text": ""
2591
- }
2027
+ "kind": "field",
2028
+ "name": "enableSearchBar",
2029
+ "type": {
2030
+ "text": "boolean"
2592
2031
  },
2593
- "parameters": [
2594
- {
2595
- "name": "slotName",
2596
- "type": {
2597
- "text": "string"
2598
- },
2599
- "description": "The name of the slot to check."
2600
- }
2601
- ],
2602
- "description": "Checks if a slot contains any content.",
2032
+ "default": "false",
2033
+ "description": "This attribute controls whether to enable the search-bar.",
2034
+ "privacy": "public",
2603
2035
  "inheritedFrom": {
2604
2036
  "name": "EntityManagement",
2605
2037
  "module": "src/entities/entities.ts"
2606
2038
  }
2607
2039
  },
2608
2040
  {
2609
- "kind": "method",
2610
- "name": "deepClone",
2611
- "return": {
2612
- "type": {
2613
- "text": "Node"
2614
- }
2041
+ "kind": "field",
2042
+ "name": "headerCaseType",
2043
+ "type": {
2044
+ "text": "GridProCaseType"
2615
2045
  },
2616
- "description": "Override the deepClone method to ensure that observable attributes are cloned",
2046
+ "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
2617
2047
  "privacy": "public",
2618
2048
  "inheritedFrom": {
2619
2049
  "name": "EntityManagement",
@@ -2621,44 +2051,38 @@
2621
2051
  }
2622
2052
  },
2623
2053
  {
2624
- "kind": "method",
2625
- "name": "submitEntityChanges",
2626
- "privacy": "public",
2627
- "parameters": [
2628
- {
2629
- "name": "e",
2630
- "type": {
2631
- "text": "CustomEvent"
2632
- },
2633
- "description": "CustomEvent which contains the payload for the entity to submit to the backend\n\nEmits an event upon error"
2634
- }
2635
- ],
2636
- "description": "Event handler for when the user submits the action for the currently open form, either editing or adding the entity",
2054
+ "kind": "field",
2055
+ "name": "searchBarConfig",
2056
+ "type": {
2057
+ "text": "AvailableOption[]"
2058
+ },
2059
+ "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @public",
2637
2060
  "inheritedFrom": {
2638
2061
  "name": "EntityManagement",
2639
2062
  "module": "src/entities/entities.ts"
2640
2063
  }
2641
2064
  },
2642
2065
  {
2643
- "kind": "method",
2644
- "name": "readEntity",
2645
- "privacy": "private",
2646
- "parameters": [
2647
- {
2648
- "name": "e",
2649
- "type": {
2650
- "text": "CustomEvent"
2651
- }
2652
- }
2653
- ],
2066
+ "kind": "field",
2067
+ "name": "modalPosition",
2068
+ "type": {
2069
+ "text": "'centre' | 'left' | 'right'"
2070
+ },
2071
+ "default": "'right'",
2072
+ "description": "Determines where the modal dialog will appear on screen",
2073
+ "privacy": "public",
2654
2074
  "inheritedFrom": {
2655
2075
  "name": "EntityManagement",
2656
2076
  "module": "src/entities/entities.ts"
2657
2077
  }
2658
2078
  },
2659
2079
  {
2660
- "kind": "method",
2661
- "name": "closeModal",
2080
+ "kind": "field",
2081
+ "name": "crudMenuPosition",
2082
+ "type": {
2083
+ "text": "CrudMenuPosition"
2084
+ },
2085
+ "description": "Determines where the buttons will appear",
2662
2086
  "privacy": "public",
2663
2087
  "inheritedFrom": {
2664
2088
  "name": "EntityManagement",
@@ -2667,8 +2091,12 @@
2667
2091
  },
2668
2092
  {
2669
2093
  "kind": "field",
2670
- "name": "headerTempalate",
2671
- "readonly": true,
2094
+ "name": "crudMenuStyle",
2095
+ "type": {
2096
+ "text": "ActionsMenuStyle"
2097
+ },
2098
+ "description": "Determines the style of the buttons",
2099
+ "privacy": "public",
2672
2100
  "inheritedFrom": {
2673
2101
  "name": "EntityManagement",
2674
2102
  "module": "src/entities/entities.ts"
@@ -2676,11 +2104,12 @@
2676
2104
  },
2677
2105
  {
2678
2106
  "kind": "field",
2679
- "name": "isServerSideDatasource",
2107
+ "name": "crudActionMenuName",
2680
2108
  "type": {
2681
- "text": "boolean"
2109
+ "text": "string"
2682
2110
  },
2683
- "readonly": true,
2111
+ "default": "'⋮'",
2112
+ "description": "The label of the crud action menu",
2684
2113
  "inheritedFrom": {
2685
2114
  "name": "EntityManagement",
2686
2115
  "module": "src/entities/entities.ts"
@@ -2688,13 +2117,13 @@
2688
2117
  },
2689
2118
  {
2690
2119
  "kind": "method",
2691
- "name": "searchChanged",
2692
- "privacy": "public",
2120
+ "name": "readEntity",
2121
+ "privacy": "private",
2693
2122
  "parameters": [
2694
2123
  {
2695
- "name": "event",
2124
+ "name": "e",
2696
2125
  "type": {
2697
- "text": "CustomEvent<Array<SelectedOption>>"
2126
+ "text": "CustomEvent"
2698
2127
  }
2699
2128
  }
2700
2129
  ],
@@ -2706,6 +2135,7 @@
2706
2135
  {
2707
2136
  "kind": "method",
2708
2137
  "name": "searchBarReqServer",
2138
+ "privacy": "private",
2709
2139
  "parameters": [
2710
2140
  {
2711
2141
  "name": "options",
@@ -2722,6 +2152,7 @@
2722
2152
  {
2723
2153
  "kind": "method",
2724
2154
  "name": "searchBarDataserver",
2155
+ "privacy": "private",
2725
2156
  "parameters": [
2726
2157
  {
2727
2158
  "name": "options",
@@ -2738,7 +2169,7 @@
2738
2169
  {
2739
2170
  "kind": "method",
2740
2171
  "name": "requestChanged",
2741
- "privacy": "public",
2172
+ "privacy": "private",
2742
2173
  "parameters": [
2743
2174
  {
2744
2175
  "name": "e",
@@ -2755,7 +2186,7 @@
2755
2186
  {
2756
2187
  "kind": "method",
2757
2188
  "name": "criteriaChanged",
2758
- "privacy": "public",
2189
+ "privacy": "private",
2759
2190
  "parameters": [
2760
2191
  {
2761
2192
  "name": "e",
@@ -2772,7 +2203,7 @@
2772
2203
  {
2773
2204
  "kind": "method",
2774
2205
  "name": "submitFailureNotification",
2775
- "privacy": "public",
2206
+ "privacy": "private",
2776
2207
  "parameters": [
2777
2208
  {
2778
2209
  "name": "e",
@@ -2811,43 +2242,6 @@
2811
2242
  "name": "EntityManagement",
2812
2243
  "module": "src/entities/entities.ts"
2813
2244
  }
2814
- },
2815
- {
2816
- "kind": "method",
2817
- "name": "emitCrud",
2818
- "privacy": "public",
2819
- "parameters": [
2820
- {
2821
- "name": "action",
2822
- "type": {
2823
- "text": "'create' | 'edit' | 'delete'"
2824
- },
2825
- "description": "the action to emit"
2826
- }
2827
- ],
2828
- "description": "Emit the CRUD event for the selected entity",
2829
- "inheritedFrom": {
2830
- "name": "EntityManagement",
2831
- "module": "src/entities/entities.ts"
2832
- }
2833
- },
2834
- {
2835
- "kind": "method",
2836
- "name": "selectionChanged",
2837
- "privacy": "public",
2838
- "parameters": [
2839
- {
2840
- "name": "event",
2841
- "type": {
2842
- "text": "CustomEvent<SelectionChangedEvent>"
2843
- }
2844
- }
2845
- ],
2846
- "description": "The event handler for when the selection changes in the grid.",
2847
- "inheritedFrom": {
2848
- "name": "EntityManagement",
2849
- "module": "src/entities/entities.ts"
2850
- }
2851
2245
  }
2852
2246
  ],
2853
2247
  "superclass": {
@@ -2888,22 +2282,13 @@
2888
2282
  "type": {
2889
2283
  "text": "string"
2890
2284
  },
2285
+ "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity",
2891
2286
  "fieldName": "readEvent",
2892
2287
  "inheritedFrom": {
2893
2288
  "name": "EntityManagement",
2894
2289
  "module": "src/entities/entities.ts"
2895
2290
  }
2896
2291
  },
2897
- {
2898
- "type": {
2899
- "text": "boolean"
2900
- },
2901
- "fieldName": "readonly",
2902
- "inheritedFrom": {
2903
- "name": "EntityManagement",
2904
- "module": "src/entities/entities.ts"
2905
- }
2906
- },
2907
2292
  {
2908
2293
  "name": "updateEvent",
2909
2294
  "type": {
@@ -2957,52 +2342,13 @@
2957
2342
  "type": {
2958
2343
  "text": "string"
2959
2344
  },
2960
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
2345
+ "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications",
2961
2346
  "fieldName": "entityLabel",
2962
2347
  "inheritedFrom": {
2963
2348
  "name": "EntityManagement",
2964
2349
  "module": "src/entities/entities.ts"
2965
2350
  }
2966
2351
  },
2967
- {
2968
- "name": "async-add",
2969
- "type": {
2970
- "text": "boolean"
2971
- },
2972
- "default": "false",
2973
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
2974
- "fieldName": "asyncAdd",
2975
- "inheritedFrom": {
2976
- "name": "EntityManagement",
2977
- "module": "src/entities/entities.ts"
2978
- }
2979
- },
2980
- {
2981
- "name": "async-remove",
2982
- "type": {
2983
- "text": "boolean"
2984
- },
2985
- "default": "false",
2986
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
2987
- "fieldName": "asyncRemove",
2988
- "inheritedFrom": {
2989
- "name": "EntityManagement",
2990
- "module": "src/entities/entities.ts"
2991
- }
2992
- },
2993
- {
2994
- "name": "async-update",
2995
- "type": {
2996
- "text": "boolean"
2997
- },
2998
- "default": "true",
2999
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
3000
- "fieldName": "asyncUpdate",
3001
- "inheritedFrom": {
3002
- "name": "EntityManagement",
3003
- "module": "src/entities/entities.ts"
3004
- }
3005
- },
3006
2352
  {
3007
2353
  "name": "row-selection",
3008
2354
  "type": {
@@ -3072,6 +2418,7 @@
3072
2418
  "type": {
3073
2419
  "text": "boolean"
3074
2420
  },
2421
+ "description": "Resizes columns to take available space",
3075
2422
  "fieldName": "sizeColumnsToFit",
3076
2423
  "inheritedFrom": {
3077
2424
  "name": "EntityManagement",
@@ -3083,6 +2430,7 @@
3083
2430
  "type": {
3084
2431
  "text": "boolean"
3085
2432
  },
2433
+ "description": "Enables filter bar component",
3086
2434
  "fieldName": "enableFilterBar",
3087
2435
  "inheritedFrom": {
3088
2436
  "name": "EntityManagement",
@@ -3095,6 +2443,7 @@
3095
2443
  "text": "boolean"
3096
2444
  },
3097
2445
  "default": "false",
2446
+ "description": "Hides edit button",
3098
2447
  "fieldName": "hideEdit",
3099
2448
  "inheritedFrom": {
3100
2449
  "name": "EntityManagement",
@@ -3107,6 +2456,7 @@
3107
2456
  "text": "boolean"
3108
2457
  },
3109
2458
  "default": "false",
2459
+ "description": "Hides delete button",
3110
2460
  "fieldName": "hideDelete",
3111
2461
  "inheritedFrom": {
3112
2462
  "name": "EntityManagement",