@genesislcap/foundation-entity-management 14.214.2-alpha-40e31af.0 → 14.214.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.
Files changed (55) hide show
  1. package/dist/custom-elements.json +375 -1025
  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
  {
@@ -1136,200 +873,6 @@
1136
873
  }
1137
874
  ]
1138
875
  },
1139
- {
1140
- "kind": "javascript-module",
1141
- "path": "src/layouts/default.ts",
1142
- "declarations": [
1143
- {
1144
- "kind": "variable",
1145
- "name": "loginLayout",
1146
- "default": "new FASTElementLayout(\n html`\n <div class=\"container\">\n <div class=\"content\">\n <slot></slot>\n </div>\n </div>\n `,\n baseLayoutCss,\n)"
1147
- },
1148
- {
1149
- "kind": "variable",
1150
- "name": "defaultLayout",
1151
- "default": "new FASTElementLayout(\n html`\n <div class=\"container\">\n <div class=\"content\">\n <slot></slot>\n </div>\n </div>\n `,\n css`\n ${baseLayoutCss}\n `,\n)"
1152
- }
1153
- ],
1154
- "exports": [
1155
- {
1156
- "kind": "js",
1157
- "name": "loginLayout",
1158
- "declaration": {
1159
- "name": "loginLayout",
1160
- "module": "src/layouts/default.ts"
1161
- }
1162
- },
1163
- {
1164
- "kind": "js",
1165
- "name": "defaultLayout",
1166
- "declaration": {
1167
- "name": "defaultLayout",
1168
- "module": "src/layouts/default.ts"
1169
- }
1170
- }
1171
- ]
1172
- },
1173
- {
1174
- "kind": "javascript-module",
1175
- "path": "src/layouts/index.ts",
1176
- "declarations": [],
1177
- "exports": [
1178
- {
1179
- "kind": "js",
1180
- "name": "*",
1181
- "declaration": {
1182
- "name": "*",
1183
- "package": "./default"
1184
- }
1185
- }
1186
- ]
1187
- },
1188
- {
1189
- "kind": "javascript-module",
1190
- "path": "src/main/index.ts",
1191
- "declarations": [],
1192
- "exports": [
1193
- {
1194
- "kind": "js",
1195
- "name": "*",
1196
- "declaration": {
1197
- "name": "*",
1198
- "package": "./main.template"
1199
- }
1200
- },
1201
- {
1202
- "kind": "js",
1203
- "name": "*",
1204
- "declaration": {
1205
- "name": "*",
1206
- "package": "./main"
1207
- }
1208
- }
1209
- ]
1210
- },
1211
- {
1212
- "kind": "javascript-module",
1213
- "path": "src/main/main.styles.ts",
1214
- "declarations": [
1215
- {
1216
- "kind": "variable",
1217
- "name": "MainStyles",
1218
- "default": "css`\n ${mixinRobotoFont()}\n :host {\n contain: content;\n }\n\n :host,\n zero-design-system-provider,\n .dynamic-template,\n foundation-router {\n display: flex;\n width: 100%;\n height: 100%;\n }\n\n fast-progress {\n --accent-foreground-rest: #654df9;\n\n height: calc(var(--design-unit) * 1px);\n margin: 0;\n width: 100%;\n }\n`"
1219
- }
1220
- ],
1221
- "exports": [
1222
- {
1223
- "kind": "js",
1224
- "name": "MainStyles",
1225
- "declaration": {
1226
- "name": "MainStyles",
1227
- "module": "src/main/main.styles.ts"
1228
- }
1229
- }
1230
- ]
1231
- },
1232
- {
1233
- "kind": "javascript-module",
1234
- "path": "src/main/main.template.ts",
1235
- "declarations": [],
1236
- "exports": []
1237
- },
1238
- {
1239
- "kind": "javascript-module",
1240
- "path": "src/main/main.ts",
1241
- "declarations": [
1242
- {
1243
- "kind": "class",
1244
- "description": "",
1245
- "name": "MainApplication",
1246
- "members": [
1247
- {
1248
- "kind": "field",
1249
- "name": "config",
1250
- "type": {
1251
- "text": "MainRouterConfig"
1252
- }
1253
- },
1254
- {
1255
- "kind": "field",
1256
- "name": "connect",
1257
- "type": {
1258
- "text": "Connect"
1259
- }
1260
- },
1261
- {
1262
- "kind": "field",
1263
- "name": "session",
1264
- "type": {
1265
- "text": "Session"
1266
- }
1267
- },
1268
- {
1269
- "kind": "field",
1270
- "name": "container",
1271
- "type": {
1272
- "text": "Container"
1273
- }
1274
- },
1275
- {
1276
- "kind": "field",
1277
- "name": "provider",
1278
- "type": {
1279
- "text": "HTMLElement"
1280
- }
1281
- },
1282
- {
1283
- "kind": "field",
1284
- "name": "ready",
1285
- "type": {
1286
- "text": "boolean"
1287
- },
1288
- "default": "false"
1289
- },
1290
- {
1291
- "kind": "method",
1292
- "name": "onLuminanceToggle"
1293
- },
1294
- {
1295
- "kind": "method",
1296
- "name": "loadRemotes"
1297
- },
1298
- {
1299
- "kind": "method",
1300
- "name": "selectTemplate"
1301
- },
1302
- {
1303
- "kind": "method",
1304
- "name": "registerDIDependencies",
1305
- "privacy": "private"
1306
- }
1307
- ],
1308
- "superclass": {
1309
- "name": "FASTElement",
1310
- "package": "@microsoft/fast-element"
1311
- },
1312
- "customElement": true
1313
- }
1314
- ],
1315
- "exports": [
1316
- {
1317
- "kind": "js",
1318
- "name": "MainApplication",
1319
- "declaration": {
1320
- "name": "MainApplication",
1321
- "module": "src/main/main.ts"
1322
- }
1323
- },
1324
- {
1325
- "kind": "custom-element-definition",
1326
- "declaration": {
1327
- "name": "MainApplication",
1328
- "module": "src/main/main.ts"
1329
- }
1330
- }
1331
- ]
1332
- },
1333
876
  {
1334
877
  "kind": "javascript-module",
1335
878
  "path": "src/list/index.ts",
@@ -1882,36 +1425,181 @@
1882
1425
  },
1883
1426
  {
1884
1427
  "kind": "javascript-module",
1885
- "path": "src/profiles/editProfileSchema.ts",
1886
- "declarations": [
1887
- {
1888
- "kind": "variable",
1889
- "name": "editProfileFormSchema",
1890
- "type": {
1891
- "text": "UiSchema"
1892
- },
1893
- "default": "{\n type: 'VerticalLayout',\n elements: [\n {\n type: 'Control',\n label: 'Name',\n scope: '#/properties/NAME',\n },\n {\n type: 'Control',\n label: 'Description',\n scope: '#/properties/DESCRIPTION',\n },\n {\n type: 'Control',\n label: 'Status',\n scope: '#/properties/STATUS',\n },\n {\n type: 'Control',\n label: 'Rights',\n scope: '#/properties/RIGHT_CODES',\n options: {\n allOptionsResourceName: 'RIGHT',\n valueField: 'CODE',\n labelField: 'CODE',\n },\n },\n {\n type: 'Control',\n label: 'Users',\n scope: '#/properties/USER_NAMES',\n options: {\n allOptionsResourceName: 'USER',\n valueField: 'USER_NAME',\n labelField: 'USER_NAME',\n },\n },\n ],\n}"
1894
- }
1895
- ],
1428
+ "path": "src/main/index.ts",
1429
+ "declarations": [],
1896
1430
  "exports": [
1897
1431
  {
1898
1432
  "kind": "js",
1899
- "name": "editProfileFormSchema",
1433
+ "name": "*",
1900
1434
  "declaration": {
1901
- "name": "editProfileFormSchema",
1902
- "module": "src/profiles/editProfileSchema.ts"
1435
+ "name": "*",
1436
+ "package": "./main.template"
1437
+ }
1438
+ },
1439
+ {
1440
+ "kind": "js",
1441
+ "name": "*",
1442
+ "declaration": {
1443
+ "name": "*",
1444
+ "package": "./main"
1903
1445
  }
1904
1446
  }
1905
1447
  ]
1906
1448
  },
1907
1449
  {
1908
1450
  "kind": "javascript-module",
1909
- "path": "src/profiles/profiles.ts",
1451
+ "path": "src/main/main.styles.ts",
1910
1452
  "declarations": [
1911
1453
  {
1912
- "kind": "class",
1913
- "description": "Main class which defined the profile management functionality",
1914
- "name": "Profiles",
1454
+ "kind": "variable",
1455
+ "name": "MainStyles",
1456
+ "default": "css`\n ${mixinRobotoFont()}\n :host {\n contain: content;\n }\n\n :host,\n zero-design-system-provider,\n .dynamic-template,\n foundation-router {\n display: flex;\n width: 100%;\n height: 100%;\n }\n\n fast-progress {\n --accent-foreground-rest: #654df9;\n\n height: calc(var(--design-unit) * 1px);\n margin: 0;\n width: 100%;\n }\n`"
1457
+ }
1458
+ ],
1459
+ "exports": [
1460
+ {
1461
+ "kind": "js",
1462
+ "name": "MainStyles",
1463
+ "declaration": {
1464
+ "name": "MainStyles",
1465
+ "module": "src/main/main.styles.ts"
1466
+ }
1467
+ }
1468
+ ]
1469
+ },
1470
+ {
1471
+ "kind": "javascript-module",
1472
+ "path": "src/main/main.template.ts",
1473
+ "declarations": [],
1474
+ "exports": []
1475
+ },
1476
+ {
1477
+ "kind": "javascript-module",
1478
+ "path": "src/main/main.ts",
1479
+ "declarations": [
1480
+ {
1481
+ "kind": "class",
1482
+ "description": "",
1483
+ "name": "MainApplication",
1484
+ "members": [
1485
+ {
1486
+ "kind": "field",
1487
+ "name": "config",
1488
+ "type": {
1489
+ "text": "MainRouterConfig"
1490
+ }
1491
+ },
1492
+ {
1493
+ "kind": "field",
1494
+ "name": "connect",
1495
+ "type": {
1496
+ "text": "Connect"
1497
+ }
1498
+ },
1499
+ {
1500
+ "kind": "field",
1501
+ "name": "session",
1502
+ "type": {
1503
+ "text": "Session"
1504
+ }
1505
+ },
1506
+ {
1507
+ "kind": "field",
1508
+ "name": "container",
1509
+ "type": {
1510
+ "text": "Container"
1511
+ }
1512
+ },
1513
+ {
1514
+ "kind": "field",
1515
+ "name": "provider",
1516
+ "type": {
1517
+ "text": "HTMLElement"
1518
+ }
1519
+ },
1520
+ {
1521
+ "kind": "field",
1522
+ "name": "ready",
1523
+ "type": {
1524
+ "text": "boolean"
1525
+ },
1526
+ "default": "false"
1527
+ },
1528
+ {
1529
+ "kind": "method",
1530
+ "name": "onLuminanceToggle"
1531
+ },
1532
+ {
1533
+ "kind": "method",
1534
+ "name": "loadRemotes"
1535
+ },
1536
+ {
1537
+ "kind": "method",
1538
+ "name": "selectTemplate"
1539
+ },
1540
+ {
1541
+ "kind": "method",
1542
+ "name": "registerDIDependencies",
1543
+ "privacy": "private"
1544
+ }
1545
+ ],
1546
+ "superclass": {
1547
+ "name": "FASTElement",
1548
+ "package": "@microsoft/fast-element"
1549
+ },
1550
+ "customElement": true
1551
+ }
1552
+ ],
1553
+ "exports": [
1554
+ {
1555
+ "kind": "js",
1556
+ "name": "MainApplication",
1557
+ "declaration": {
1558
+ "name": "MainApplication",
1559
+ "module": "src/main/main.ts"
1560
+ }
1561
+ },
1562
+ {
1563
+ "kind": "custom-element-definition",
1564
+ "declaration": {
1565
+ "name": "MainApplication",
1566
+ "module": "src/main/main.ts"
1567
+ }
1568
+ }
1569
+ ]
1570
+ },
1571
+ {
1572
+ "kind": "javascript-module",
1573
+ "path": "src/profiles/editProfileSchema.ts",
1574
+ "declarations": [
1575
+ {
1576
+ "kind": "variable",
1577
+ "name": "editProfileFormSchema",
1578
+ "type": {
1579
+ "text": "UiSchema"
1580
+ },
1581
+ "default": "{\n type: 'VerticalLayout',\n elements: [\n {\n type: 'Control',\n label: 'Name',\n scope: '#/properties/NAME',\n },\n {\n type: 'Control',\n label: 'Description',\n scope: '#/properties/DESCRIPTION',\n },\n {\n type: 'Control',\n label: 'Status',\n scope: '#/properties/STATUS',\n },\n {\n type: 'Control',\n label: 'Rights',\n scope: '#/properties/RIGHT_CODES',\n options: {\n allOptionsResourceName: 'RIGHT',\n valueField: 'CODE',\n labelField: 'CODE',\n },\n },\n {\n type: 'Control',\n label: 'Users',\n scope: '#/properties/USER_NAMES',\n options: {\n allOptionsResourceName: 'USER',\n valueField: 'USER_NAME',\n labelField: 'USER_NAME',\n },\n },\n ],\n}"
1582
+ }
1583
+ ],
1584
+ "exports": [
1585
+ {
1586
+ "kind": "js",
1587
+ "name": "editProfileFormSchema",
1588
+ "declaration": {
1589
+ "name": "editProfileFormSchema",
1590
+ "module": "src/profiles/editProfileSchema.ts"
1591
+ }
1592
+ }
1593
+ ]
1594
+ },
1595
+ {
1596
+ "kind": "javascript-module",
1597
+ "path": "src/profiles/profiles.ts",
1598
+ "declarations": [
1599
+ {
1600
+ "kind": "class",
1601
+ "description": "Main class which defined the profile management functionality",
1602
+ "name": "Profiles",
1915
1603
  "members": [
1916
1604
  {
1917
1605
  "kind": "method",
@@ -1925,11 +1613,7 @@
1925
1613
  },
1926
1614
  {
1927
1615
  "kind": "method",
1928
- "name": "confirmDelete",
1929
- "inheritedFrom": {
1930
- "name": "EntityManagement",
1931
- "module": "src/entities/entities.ts"
1932
- }
1616
+ "name": "confirmDelete"
1933
1617
  },
1934
1618
  {
1935
1619
  "kind": "field",
@@ -1990,6 +1674,8 @@
1990
1674
  "type": {
1991
1675
  "text": "UiSchema"
1992
1676
  },
1677
+ "description": "Enables you to supply a schema to configure an update form.",
1678
+ "privacy": "public",
1993
1679
  "default": "editProfileFormSchema",
1994
1680
  "inheritedFrom": {
1995
1681
  "name": "EntityManagement",
@@ -2002,6 +1688,8 @@
2002
1688
  "type": {
2003
1689
  "text": "UiSchema"
2004
1690
  },
1691
+ "description": "Enables you to supply a schema to configure an insert form.",
1692
+ "privacy": "public",
2005
1693
  "default": "editProfileFormSchema",
2006
1694
  "inheritedFrom": {
2007
1695
  "name": "EntityManagement",
@@ -2012,8 +1700,21 @@
2012
1700
  "kind": "field",
2013
1701
  "name": "readEventFn",
2014
1702
  "type": {
2015
- "text": "(...args) => {}"
1703
+ "text": "(entity) => any"
1704
+ },
1705
+ "description": "Similar to readEvent but allows to provide function that will be executed before\nopening the form and yields data to the form",
1706
+ "parameters": [
1707
+ {
1708
+ "description": "selected entity from the grid",
1709
+ "name": "entity"
1710
+ }
1711
+ ],
1712
+ "return": {
1713
+ "type": {
1714
+ "text": ""
1715
+ }
2016
1716
  },
1717
+ "privacy": "public",
2017
1718
  "inheritedFrom": {
2018
1719
  "name": "EntityManagement",
2019
1720
  "module": "src/entities/entities.ts"
@@ -2053,7 +1754,7 @@
2053
1754
  "type": {
2054
1755
  "text": "string"
2055
1756
  },
2056
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
1757
+ "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
1758
  "privacy": "public",
2058
1759
  "default": "'Profile'",
2059
1760
  "inheritedFrom": {
@@ -2061,19 +1762,6 @@
2061
1762
  "module": "src/entities/entities.ts"
2062
1763
  }
2063
1764
  },
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
1765
  {
2078
1766
  "kind": "field",
2079
1767
  "name": "prefix",
@@ -2094,58 +1782,7 @@
2094
1782
  "type": {
2095
1783
  "text": "string"
2096
1784
  },
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",
1785
+ "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",
2149
1786
  "privacy": "public",
2150
1787
  "inheritedFrom": {
2151
1788
  "name": "EntityManagement",
@@ -2236,254 +1873,11 @@
2236
1873
  },
2237
1874
  {
2238
1875
  "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",
2383
- "type": {
2384
- "text": "boolean"
2385
- },
2386
- "inheritedFrom": {
2387
- "name": "EntityManagement",
2388
- "module": "src/entities/entities.ts"
2389
- }
2390
- },
2391
- {
2392
- "kind": "field",
2393
- "name": "hideEdit",
2394
- "type": {
2395
- "text": "boolean"
2396
- },
2397
- "default": "false",
2398
- "inheritedFrom": {
2399
- "name": "EntityManagement",
2400
- "module": "src/entities/entities.ts"
2401
- }
2402
- },
2403
- {
2404
- "kind": "field",
2405
- "name": "hideDelete",
2406
- "type": {
2407
- "text": "boolean"
2408
- },
2409
- "default": "false",
2410
- "inheritedFrom": {
2411
- "name": "EntityManagement",
2412
- "module": "src/entities/entities.ts"
2413
- }
2414
- },
2415
- {
2416
- "kind": "field",
2417
- "name": "enableSearchBar",
2418
- "type": {
2419
- "text": "boolean"
2420
- },
2421
- "default": "false",
2422
- "description": "This attribute controls whether to enable the search-bar.",
2423
- "privacy": "public",
2424
- "inheritedFrom": {
2425
- "name": "EntityManagement",
2426
- "module": "src/entities/entities.ts"
2427
- }
2428
- },
2429
- {
2430
- "kind": "field",
2431
- "name": "headerCaseType",
2432
- "type": {
2433
- "text": "GridProCaseType"
2434
- },
2435
- "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
2436
- "privacy": "public",
2437
- "inheritedFrom": {
2438
- "name": "EntityManagement",
2439
- "module": "src/entities/entities.ts"
2440
- }
2441
- },
2442
- {
2443
- "kind": "field",
2444
- "name": "searchBarConfig",
2445
- "type": {
2446
- "text": "AvailableOption[]"
2447
- },
2448
- "inheritedFrom": {
2449
- "name": "EntityManagement",
2450
- "module": "src/entities/entities.ts"
2451
- }
2452
- },
2453
- {
2454
- "kind": "field",
2455
- "name": "modalPosition",
2456
- "type": {
2457
- "text": "'centre' | 'left' | 'right'"
2458
- },
2459
- "default": "'right'",
2460
- "description": "Determines where the modal dialog will appear on screen",
2461
- "privacy": "public",
2462
- "inheritedFrom": {
2463
- "name": "EntityManagement",
2464
- "module": "src/entities/entities.ts"
2465
- }
2466
- },
2467
- {
2468
- "kind": "field",
2469
- "name": "crudMenuPosition",
2470
- "type": {
2471
- "text": "CrudMenuPosition"
2472
- },
2473
- "description": "Determines where the buttons will appear",
2474
- "privacy": "public",
2475
- "inheritedFrom": {
2476
- "name": "EntityManagement",
2477
- "module": "src/entities/entities.ts"
2478
- }
2479
- },
2480
- {
2481
- "kind": "field",
2482
- "name": "crudMenuStyle",
1876
+ "name": "datasourceConfig",
2483
1877
  "type": {
2484
- "text": "ActionsMenuStyle"
1878
+ "text": "DatasourceConfiguration"
2485
1879
  },
2486
- "description": "Determines the style of the buttons",
1880
+ "description": "The configuration which is used when interacting with the resource on the backend",
2487
1881
  "privacy": "public",
2488
1882
  "inheritedFrom": {
2489
1883
  "name": "EntityManagement",
@@ -2492,12 +1886,13 @@
2492
1886
  },
2493
1887
  {
2494
1888
  "kind": "field",
2495
- "name": "crudActionMenuName",
1889
+ "name": "formRenderers",
2496
1890
  "type": {
2497
- "text": "string"
1891
+ "text": "RendererEntry[]"
2498
1892
  },
2499
- "default": "'⋮'",
2500
- "description": "The label of the crud action menu",
1893
+ "default": "renderers",
1894
+ "description": "Array with renderers used by foundation-forms",
1895
+ "privacy": "public",
2501
1896
  "inheritedFrom": {
2502
1897
  "name": "EntityManagement",
2503
1898
  "module": "src/entities/entities.ts"
@@ -2505,9 +1900,12 @@
2505
1900
  },
2506
1901
  {
2507
1902
  "kind": "field",
2508
- "name": "crudMenuWrapper",
1903
+ "name": "defaultEntityValues",
1904
+ "type": {
1905
+ "text": "Record<string, unknown>"
1906
+ },
1907
+ "description": "The default values to populate the form with when the user is adding an entity",
2509
1908
  "privacy": "public",
2510
- "description": "The Id of the crud buttons wrapper element",
2511
1909
  "inheritedFrom": {
2512
1910
  "name": "EntityManagement",
2513
1911
  "module": "src/entities/entities.ts"
@@ -2515,18 +1913,8 @@
2515
1913
  },
2516
1914
  {
2517
1915
  "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",
1916
+ "name": "editModalVisibleChanged",
1917
+ "privacy": "private",
2530
1918
  "inheritedFrom": {
2531
1919
  "name": "EntityManagement",
2532
1920
  "module": "src/entities/entities.ts"
@@ -2534,9 +1922,12 @@
2534
1922
  },
2535
1923
  {
2536
1924
  "kind": "field",
2537
- "name": "modalFormTitle",
2538
- "description": "Getter for the title of the modal form",
2539
- "readonly": true,
1925
+ "name": "sizeColumnsToFit",
1926
+ "type": {
1927
+ "text": "boolean"
1928
+ },
1929
+ "description": "Resizes columns to take available space",
1930
+ "privacy": "public",
2540
1931
  "inheritedFrom": {
2541
1932
  "name": "EntityManagement",
2542
1933
  "module": "src/entities/entities.ts"
@@ -2544,12 +1935,12 @@
2544
1935
  },
2545
1936
  {
2546
1937
  "kind": "field",
2547
- "name": "shouldHideEditInColumn",
1938
+ "name": "enableFilterBar",
2548
1939
  "type": {
2549
1940
  "text": "boolean"
2550
1941
  },
2551
- "description": "Determines whether the button edit should be hidden in the column",
2552
- "readonly": true,
1942
+ "description": "Enables filter bar component",
1943
+ "privacy": "public",
2553
1944
  "inheritedFrom": {
2554
1945
  "name": "EntityManagement",
2555
1946
  "module": "src/entities/entities.ts"
@@ -2557,12 +1948,13 @@
2557
1948
  },
2558
1949
  {
2559
1950
  "kind": "field",
2560
- "name": "shouldHideDeleteInColumn",
1951
+ "name": "hideEdit",
2561
1952
  "type": {
2562
1953
  "text": "boolean"
2563
1954
  },
2564
- "description": "Determines whether the button delete should be hidden in the column",
2565
- "readonly": true,
1955
+ "default": "false",
1956
+ "description": "Hides edit button",
1957
+ "privacy": "public",
2566
1958
  "inheritedFrom": {
2567
1959
  "name": "EntityManagement",
2568
1960
  "module": "src/entities/entities.ts"
@@ -2570,50 +1962,39 @@
2570
1962
  },
2571
1963
  {
2572
1964
  "kind": "field",
2573
- "name": "hasSelectedEntity",
1965
+ "name": "hideDelete",
2574
1966
  "type": {
2575
1967
  "text": "boolean"
2576
1968
  },
2577
- "description": "Determines whether there is a selected entity",
2578
- "readonly": true,
1969
+ "default": "false",
1970
+ "description": "Hides delete button",
1971
+ "privacy": "public",
2579
1972
  "inheritedFrom": {
2580
1973
  "name": "EntityManagement",
2581
1974
  "module": "src/entities/entities.ts"
2582
1975
  }
2583
1976
  },
2584
1977
  {
2585
- "kind": "method",
2586
- "name": "hasContentInSlot",
2587
- "privacy": "public",
2588
- "return": {
2589
- "type": {
2590
- "text": ""
2591
- }
1978
+ "kind": "field",
1979
+ "name": "enableSearchBar",
1980
+ "type": {
1981
+ "text": "boolean"
2592
1982
  },
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.",
1983
+ "default": "false",
1984
+ "description": "This attribute controls whether to enable the search-bar.",
1985
+ "privacy": "public",
2603
1986
  "inheritedFrom": {
2604
1987
  "name": "EntityManagement",
2605
1988
  "module": "src/entities/entities.ts"
2606
1989
  }
2607
1990
  },
2608
1991
  {
2609
- "kind": "method",
2610
- "name": "deepClone",
2611
- "return": {
2612
- "type": {
2613
- "text": "Node"
2614
- }
1992
+ "kind": "field",
1993
+ "name": "headerCaseType",
1994
+ "type": {
1995
+ "text": "GridProCaseType"
2615
1996
  },
2616
- "description": "Override the deepClone method to ensure that observable attributes are cloned",
1997
+ "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
2617
1998
  "privacy": "public",
2618
1999
  "inheritedFrom": {
2619
2000
  "name": "EntityManagement",
@@ -2621,44 +2002,38 @@
2621
2002
  }
2622
2003
  },
2623
2004
  {
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",
2005
+ "kind": "field",
2006
+ "name": "searchBarConfig",
2007
+ "type": {
2008
+ "text": "AvailableOption[]"
2009
+ },
2010
+ "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @public",
2637
2011
  "inheritedFrom": {
2638
2012
  "name": "EntityManagement",
2639
2013
  "module": "src/entities/entities.ts"
2640
2014
  }
2641
2015
  },
2642
2016
  {
2643
- "kind": "method",
2644
- "name": "readEntity",
2645
- "privacy": "private",
2646
- "parameters": [
2647
- {
2648
- "name": "e",
2649
- "type": {
2650
- "text": "CustomEvent"
2651
- }
2652
- }
2653
- ],
2017
+ "kind": "field",
2018
+ "name": "modalPosition",
2019
+ "type": {
2020
+ "text": "'centre' | 'left' | 'right'"
2021
+ },
2022
+ "default": "'right'",
2023
+ "description": "Determines where the modal dialog will appear on screen",
2024
+ "privacy": "public",
2654
2025
  "inheritedFrom": {
2655
2026
  "name": "EntityManagement",
2656
2027
  "module": "src/entities/entities.ts"
2657
2028
  }
2658
2029
  },
2659
2030
  {
2660
- "kind": "method",
2661
- "name": "closeModal",
2031
+ "kind": "field",
2032
+ "name": "crudMenuPosition",
2033
+ "type": {
2034
+ "text": "CrudMenuPosition"
2035
+ },
2036
+ "description": "Determines where the buttons will appear",
2662
2037
  "privacy": "public",
2663
2038
  "inheritedFrom": {
2664
2039
  "name": "EntityManagement",
@@ -2667,8 +2042,12 @@
2667
2042
  },
2668
2043
  {
2669
2044
  "kind": "field",
2670
- "name": "headerTempalate",
2671
- "readonly": true,
2045
+ "name": "crudMenuStyle",
2046
+ "type": {
2047
+ "text": "ActionsMenuStyle"
2048
+ },
2049
+ "description": "Determines the style of the buttons",
2050
+ "privacy": "public",
2672
2051
  "inheritedFrom": {
2673
2052
  "name": "EntityManagement",
2674
2053
  "module": "src/entities/entities.ts"
@@ -2676,11 +2055,12 @@
2676
2055
  },
2677
2056
  {
2678
2057
  "kind": "field",
2679
- "name": "isServerSideDatasource",
2058
+ "name": "crudActionMenuName",
2680
2059
  "type": {
2681
- "text": "boolean"
2060
+ "text": "string"
2682
2061
  },
2683
- "readonly": true,
2062
+ "default": "'⋮'",
2063
+ "description": "The label of the crud action menu",
2684
2064
  "inheritedFrom": {
2685
2065
  "name": "EntityManagement",
2686
2066
  "module": "src/entities/entities.ts"
@@ -2688,13 +2068,13 @@
2688
2068
  },
2689
2069
  {
2690
2070
  "kind": "method",
2691
- "name": "searchChanged",
2692
- "privacy": "public",
2071
+ "name": "readEntity",
2072
+ "privacy": "private",
2693
2073
  "parameters": [
2694
2074
  {
2695
- "name": "event",
2075
+ "name": "e",
2696
2076
  "type": {
2697
- "text": "CustomEvent<Array<SelectedOption>>"
2077
+ "text": "CustomEvent"
2698
2078
  }
2699
2079
  }
2700
2080
  ],
@@ -2706,6 +2086,7 @@
2706
2086
  {
2707
2087
  "kind": "method",
2708
2088
  "name": "searchBarReqServer",
2089
+ "privacy": "private",
2709
2090
  "parameters": [
2710
2091
  {
2711
2092
  "name": "options",
@@ -2722,6 +2103,7 @@
2722
2103
  {
2723
2104
  "kind": "method",
2724
2105
  "name": "searchBarDataserver",
2106
+ "privacy": "private",
2725
2107
  "parameters": [
2726
2108
  {
2727
2109
  "name": "options",
@@ -2738,7 +2120,7 @@
2738
2120
  {
2739
2121
  "kind": "method",
2740
2122
  "name": "requestChanged",
2741
- "privacy": "public",
2123
+ "privacy": "private",
2742
2124
  "parameters": [
2743
2125
  {
2744
2126
  "name": "e",
@@ -2755,7 +2137,7 @@
2755
2137
  {
2756
2138
  "kind": "method",
2757
2139
  "name": "criteriaChanged",
2758
- "privacy": "public",
2140
+ "privacy": "private",
2759
2141
  "parameters": [
2760
2142
  {
2761
2143
  "name": "e",
@@ -2772,7 +2154,7 @@
2772
2154
  {
2773
2155
  "kind": "method",
2774
2156
  "name": "submitFailureNotification",
2775
- "privacy": "public",
2157
+ "privacy": "private",
2776
2158
  "parameters": [
2777
2159
  {
2778
2160
  "name": "e",
@@ -2811,43 +2193,6 @@
2811
2193
  "name": "EntityManagement",
2812
2194
  "module": "src/entities/entities.ts"
2813
2195
  }
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
2196
  }
2852
2197
  ],
2853
2198
  "superclass": {
@@ -2888,22 +2233,13 @@
2888
2233
  "type": {
2889
2234
  "text": "string"
2890
2235
  },
2236
+ "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
2237
  "fieldName": "readEvent",
2892
2238
  "inheritedFrom": {
2893
2239
  "name": "EntityManagement",
2894
2240
  "module": "src/entities/entities.ts"
2895
2241
  }
2896
2242
  },
2897
- {
2898
- "type": {
2899
- "text": "boolean"
2900
- },
2901
- "fieldName": "readonly",
2902
- "inheritedFrom": {
2903
- "name": "EntityManagement",
2904
- "module": "src/entities/entities.ts"
2905
- }
2906
- },
2907
2243
  {
2908
2244
  "name": "updateEvent",
2909
2245
  "type": {
@@ -2957,52 +2293,13 @@
2957
2293
  "type": {
2958
2294
  "text": "string"
2959
2295
  },
2960
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
2296
+ "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
2297
  "fieldName": "entityLabel",
2962
2298
  "inheritedFrom": {
2963
2299
  "name": "EntityManagement",
2964
2300
  "module": "src/entities/entities.ts"
2965
2301
  }
2966
2302
  },
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
2303
  {
3007
2304
  "name": "row-selection",
3008
2305
  "type": {
@@ -3072,6 +2369,7 @@
3072
2369
  "type": {
3073
2370
  "text": "boolean"
3074
2371
  },
2372
+ "description": "Resizes columns to take available space",
3075
2373
  "fieldName": "sizeColumnsToFit",
3076
2374
  "inheritedFrom": {
3077
2375
  "name": "EntityManagement",
@@ -3083,6 +2381,7 @@
3083
2381
  "type": {
3084
2382
  "text": "boolean"
3085
2383
  },
2384
+ "description": "Enables filter bar component",
3086
2385
  "fieldName": "enableFilterBar",
3087
2386
  "inheritedFrom": {
3088
2387
  "name": "EntityManagement",
@@ -3095,6 +2394,7 @@
3095
2394
  "text": "boolean"
3096
2395
  },
3097
2396
  "default": "false",
2397
+ "description": "Hides edit button",
3098
2398
  "fieldName": "hideEdit",
3099
2399
  "inheritedFrom": {
3100
2400
  "name": "EntityManagement",
@@ -3107,6 +2407,7 @@
3107
2407
  "text": "boolean"
3108
2408
  },
3109
2409
  "default": "false",
2410
+ "description": "Hides delete button",
3110
2411
  "fieldName": "hideDelete",
3111
2412
  "inheritedFrom": {
3112
2413
  "name": "EntityManagement",
@@ -3210,6 +2511,55 @@
3210
2511
  }
3211
2512
  ]
3212
2513
  },
2514
+ {
2515
+ "kind": "javascript-module",
2516
+ "path": "src/layouts/default.ts",
2517
+ "declarations": [
2518
+ {
2519
+ "kind": "variable",
2520
+ "name": "loginLayout",
2521
+ "default": "new FASTElementLayout(\n html`\n <div class=\"container\">\n <div class=\"content\">\n <slot></slot>\n </div>\n </div>\n `,\n baseLayoutCss,\n)"
2522
+ },
2523
+ {
2524
+ "kind": "variable",
2525
+ "name": "defaultLayout",
2526
+ "default": "new FASTElementLayout(\n html`\n <div class=\"container\">\n <div class=\"content\">\n <slot></slot>\n </div>\n </div>\n `,\n css`\n ${baseLayoutCss}\n `,\n)"
2527
+ }
2528
+ ],
2529
+ "exports": [
2530
+ {
2531
+ "kind": "js",
2532
+ "name": "loginLayout",
2533
+ "declaration": {
2534
+ "name": "loginLayout",
2535
+ "module": "src/layouts/default.ts"
2536
+ }
2537
+ },
2538
+ {
2539
+ "kind": "js",
2540
+ "name": "defaultLayout",
2541
+ "declaration": {
2542
+ "name": "defaultLayout",
2543
+ "module": "src/layouts/default.ts"
2544
+ }
2545
+ }
2546
+ ]
2547
+ },
2548
+ {
2549
+ "kind": "javascript-module",
2550
+ "path": "src/layouts/index.ts",
2551
+ "declarations": [],
2552
+ "exports": [
2553
+ {
2554
+ "kind": "js",
2555
+ "name": "*",
2556
+ "declaration": {
2557
+ "name": "*",
2558
+ "package": "./default"
2559
+ }
2560
+ }
2561
+ ]
2562
+ },
3213
2563
  {
3214
2564
  "kind": "javascript-module",
3215
2565
  "path": "src/routes/config.ts",