@genesislcap/foundation-entity-management 14.150.0 → 14.150.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 (2) hide show
  1. package/dist/custom-elements.json +619 -619
  2. package/package.json +21 -21
package/dist/custom-elements.json CHANGED
@@ -89,27 +89,7 @@
89
89
  },
90
90
  {
91
91
  "kind": "javascript-module",
92
- "path": "src/components/components.ts",
93
- "declarations": [
94
- {
95
- "kind": "function",
96
- "name": "loadRemotes"
97
- }
98
- ],
99
- "exports": [
100
- {
101
- "kind": "js",
102
- "name": "loadRemotes",
103
- "declaration": {
104
- "name": "loadRemotes",
105
- "module": "src/components/components.ts"
106
- }
107
- }
108
- ]
109
- },
110
- {
111
- "kind": "javascript-module",
112
- "path": "src/components/index.ts",
92
+ "path": "src/list/index.ts",
113
93
  "declarations": [],
114
94
  "exports": [
115
95
  {
@@ -117,206 +97,176 @@
117
97
  "name": "*",
118
98
  "declaration": {
119
99
  "name": "*",
120
- "package": "./components"
100
+ "package": "./list"
121
101
  }
122
102
  }
123
103
  ]
124
104
  },
125
105
  {
126
106
  "kind": "javascript-module",
127
- "path": "src/entities/entities.styles.ts",
107
+ "path": "src/list/list.styles.ts",
128
108
  "declarations": [
129
109
  {
130
110
  "kind": "variable",
131
- "name": "styles",
132
- "default": "css`\n :host {\n contain: content;\n }\n\n .container {\n display: flex;\n flex-direction: column;\n height: 100%;\n }\n\n foundation-form {\n height: 100%;\n overflow-y: auto;\n display: flex;\n flex-direction: column;\n justify-content: space-between;\n }\n\n .title {\n margin-left: 1px;\n }\n\n :host::part(header) {\n display: flex;\n justify-content: space-between;\n align-items: center;\n }\n\n .search-container {\n display: flex;\n align-items: center;\n }\n\n .search-container zero-search-bar {\n width: 500px;\n }\n`",
133
- "description": "Defines the css of the entity component as an ElementStyles object"
111
+ "name": "listStyles",
112
+ "default": "css`\n :host {\n contain: content;\n }\n\n :host,\n fast-router {\n display: flex;\n flex-direction: column;\n width: 100%;\n height: 100%;\n }\n\n .container {\n display: flex;\n flex-direction: column;\n height: inherit;\n width: 100%;\n }\n`"
134
113
  }
135
114
  ],
136
115
  "exports": [
137
116
  {
138
117
  "kind": "js",
139
- "name": "styles",
118
+ "name": "listStyles",
140
119
  "declaration": {
141
- "name": "styles",
142
- "module": "src/entities/entities.styles.ts"
120
+ "name": "listStyles",
121
+ "module": "src/list/list.styles.ts"
143
122
  }
144
123
  }
145
124
  ]
146
125
  },
147
126
  {
148
127
  "kind": "javascript-module",
149
- "path": "src/entities/entities.template.ts",
128
+ "path": "src/list/list.template.ts",
150
129
  "declarations": [
151
130
  {
152
131
  "kind": "variable",
153
- "name": "template",
154
- "default": "html<EntityManagement>`\n <div class=\"container\">\n <slot name=\"header\" part=\"header\">${(x) => x.headerTempalate}</slot>\n <entity-list\n title=${(x) => x.title}\n async-add=${(x) => x.asyncAdd}\n async-remove=${(x) => x.asyncRemove}\n async-update=${(x) => x.asyncUpdate}\n enable-cell-flashing=${(x) => x.enableCellFlashing}\n enable-row-flashing=${(x) => x.enableRowFlashing}\n persist-column-state-key=${(x) => x.persistColumnStateKey}\n size-columns-to-fit=${(x) => x.sizeColumnsToFit}\n enable-filter-bar=${(x) => x.enableFilterBar}\n resourceName=${(x) => x.resourceName}\n :deleteEvent=${(x) => x.deleteEvent}\n :updateEvent=${(x) => x.updateEvent}\n :gridOptions=${(x) => x.gridOptions}\n :columns=${(x) => x.columns}\n :datasourceConfig=${(x) => x.datasourceConfig}\n data-test-id=\"entity-list\"\n hide-edit=${(x) => x.hideEdit}\n hide-delete=${(x) => x.hideDelete}\n header-case-type=${(x) => x.headerCaseType}\n >\n <slot name=\"header\" slot=\"header\">${defaultHeader}</slot>\n </entity-list>\n <zero-modal\n ${ref('editEntityModal')}\n position=${(x) => x.modalPosition}\n :onCloseCallback=${(x) => x.closeModal.bind(x)}\n data-test-id=\"edit-entity-modal\"\n >\n <div slot=\"top\" data-test-id=\"dialog-title\">${(x) => x.editDialogTitle}</div>\n\n <slot name=\"edit\">\n ${when(\n (x) => x.editModalVisible,\n html<EntityManagement>`\n <foundation-form\n part=\"form\"\n :renderers=${(x) => x.formRenderers}\n resourceName=${(x) => x.formResourceName}\n :data=${(x) => x.editedEntity}\n :uischema=${(x) => x.formUiSchema}\n readonly=${(x) => x.readonly}\n @submit-success=${(x, c) => x.submitEntityChanges(c.event as CustomEvent)}\n ></foundation-form>\n `,\n )}\n </slot>\n </zero-modal>\n </div>\n`",
155
- "description": "Defines the html of the entity component as a ViewTemplate object"
132
+ "name": "listTemplate",
133
+ "default": "html<List>`\n <div class=\"container\">\n ${when(\n (x) => x.enableFilterBar,\n html<List>`\n <zero-filter-bar\n resource=${(x) => x.resourceName}\n only=${(x) => x.columns?.map((colDef) => colDef.field).filter((field) => !!field)}\n labels=${(x) => x.columns?.map((colDef) => colDef.headerName || '')}\n target=\"datasource\"\n ></zero-filter-bar>\n `,\n )}\n <zero-grid-pro\n ${ref('grid')}\n auto-cell-renderer-by-type\n rowSelection=\"single\"\n rowHeight=\"36\"\n headerHeight=\"36\"\n persist-column-state-key=${(x) => x.persistColumnStateKey}\n ?only-template-col-defs=${(x) => !!x.columns}\n readOnlyEdit=\"true\"\n tooltipMouseTrack=\"true\"\n tooltipShowDelay=\"0\"\n async-add=${(x) => x.asyncAdd}\n async-remove=${(x) => x.asyncRemove}\n async-update=${(x) => x.asyncUpdate}\n enable-cell-flashing=${(x) => x.enableCellFlashing}\n enable-row-flashing=${(x) => x.enableRowFlashing}\n header-case-type=${(x) => x.headerCaseType}\n >\n <grid-pro-genesis-datasource\n ${ref('datasource')}\n :deferredGridOptions=${(x) => x.gridOptions}\n criteria=${(x) => x.datasourceConfig?.criteria}\n fields=${(x) => x.datasourceConfig?.fields}\n is-snapshot=${(x) => x.datasourceConfig?.isSnapshot}\n max-rows=${(x) => x.datasourceConfig?.maxRows}\n max-view=${(x) => x.datasourceConfig?.maxView}\n moving-view=${(x) => x.datasourceConfig?.movingView}\n order-by=${(x) => x.datasourceConfig?.orderBy}\n polling-interval=${(x) => x.datasourceConfig?.pollingInterval}\n resource-name=${(x) => x.resourceName}\n reverse=${(x) => x.datasourceConfig?.reverse}\n ></grid-pro-genesis-datasource>\n ${repeat(\n (x) => x.columns,\n html`\n <grid-pro-column :definition=${(x) => x}></grid-pro-column>\n `,\n )}\n ${repeat(\n (x) => x.actionButtonsConfig,\n html`\n <grid-pro-column :definition=${(x) => x}></grid-pro-column>\n `,\n )}\n </zero-grid-pro>\n </div>\n`"
156
134
  }
157
135
  ],
158
136
  "exports": [
159
137
  {
160
138
  "kind": "js",
161
- "name": "template",
139
+ "name": "listTemplate",
162
140
  "declaration": {
163
- "name": "template",
164
- "module": "src/entities/entities.template.ts"
141
+ "name": "listTemplate",
142
+ "module": "src/list/list.template.ts"
165
143
  }
166
144
  }
167
145
  ]
168
146
  },
169
147
  {
170
148
  "kind": "javascript-module",
171
- "path": "src/entities/entities.ts",
149
+ "path": "src/list/list.ts",
172
150
  "declarations": [
173
151
  {
174
152
  "kind": "class",
175
- "description": "Main class which defines the entity management functionality",
176
- "name": "EntityManagement",
153
+ "description": "",
154
+ "name": "List",
177
155
  "members": [
178
156
  {
179
157
  "kind": "field",
180
- "name": "connect",
158
+ "name": "resourceName",
181
159
  "type": {
182
- "text": "Connect"
160
+ "text": "string"
183
161
  },
184
- "privacy": "protected",
185
- "description": "DI connect object which is used to interact with the backend."
162
+ "default": "''"
186
163
  },
187
164
  {
188
165
  "kind": "field",
189
- "name": "resourceName",
166
+ "name": "title",
190
167
  "type": {
191
168
  "text": "string"
192
169
  },
193
- "description": "Name of the backend resource which contain the entities to manage",
194
- "privacy": "public"
170
+ "default": "''"
195
171
  },
196
172
  {
197
173
  "kind": "field",
198
- "name": "readEvent",
174
+ "name": "persistColumnStateKey",
199
175
  "type": {
200
176
  "text": "string"
201
177
  }
202
178
  },
203
179
  {
204
180
  "kind": "field",
205
- "name": "readEventFn",
181
+ "name": "sizeColumnsToFit",
206
182
  "type": {
207
- "text": "(...args) => {}"
183
+ "text": "boolean"
208
184
  }
209
185
  },
210
186
  {
211
187
  "kind": "field",
212
- "name": "readonly",
188
+ "name": "enableFilterBar",
213
189
  "type": {
214
190
  "text": "boolean"
215
191
  }
216
192
  },
217
193
  {
218
194
  "kind": "field",
219
- "name": "updateEvent",
220
- "type": {
221
- "text": "string"
222
- },
223
- "description": "Name of the event handler on the Genesis server which handles updating the entity",
224
- "privacy": "public"
225
- },
226
- {
227
- "kind": "field",
228
- "name": "deleteEvent",
195
+ "name": "asyncAdd",
229
196
  "type": {
230
- "text": "string"
197
+ "text": "boolean"
231
198
  },
232
- "description": "Name of the event handler on the Genesis server which handles deleting the entity",
233
- "privacy": "public"
199
+ "default": "false"
234
200
  },
235
201
  {
236
202
  "kind": "field",
237
- "name": "createEvent",
203
+ "name": "asyncRemove",
238
204
  "type": {
239
- "text": "string"
205
+ "text": "boolean"
240
206
  },
241
- "description": "Name of the event handler on the Genesis server which handles creating an entity",
242
- "privacy": "public"
207
+ "default": "false"
243
208
  },
244
209
  {
245
210
  "kind": "field",
246
- "name": "title",
211
+ "name": "asyncUpdate",
247
212
  "type": {
248
- "text": "string"
213
+ "text": "boolean"
249
214
  },
250
- "description": "Title of the grid",
251
- "privacy": "public"
215
+ "default": "true"
252
216
  },
253
217
  {
254
218
  "kind": "field",
255
- "name": "entityLabel",
219
+ "name": "enableCellFlashing",
256
220
  "type": {
257
- "text": "string"
221
+ "text": "boolean"
258
222
  },
259
- "default": "''",
260
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
261
- "privacy": "public"
223
+ "default": "false"
262
224
  },
263
225
  {
264
226
  "kind": "field",
265
- "name": "asyncAdd",
227
+ "name": "enableRowFlashing",
266
228
  "type": {
267
229
  "text": "boolean"
268
230
  },
269
- "default": "false",
270
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
271
- "privacy": "public"
231
+ "default": "false"
272
232
  },
273
233
  {
274
234
  "kind": "field",
275
- "name": "asyncRemove",
235
+ "name": "hideEdit",
276
236
  "type": {
277
237
  "text": "boolean"
278
238
  },
279
- "default": "false",
280
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
281
- "privacy": "public"
239
+ "default": "false"
282
240
  },
283
241
  {
284
242
  "kind": "field",
285
- "name": "asyncUpdate",
243
+ "name": "hideDelete",
286
244
  "type": {
287
245
  "text": "boolean"
288
246
  },
289
- "default": "true",
290
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
291
- "privacy": "public"
247
+ "default": "false"
292
248
  },
293
249
  {
294
250
  "kind": "field",
295
- "name": "enableCellFlashing",
251
+ "name": "headerCaseType",
296
252
  "type": {
297
- "text": "boolean"
298
- },
299
- "default": "false",
300
- "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
301
- "privacy": "public"
253
+ "text": "GridProCaseType"
254
+ }
302
255
  },
303
256
  {
304
257
  "kind": "field",
305
- "name": "enableRowFlashing",
258
+ "name": "grid",
306
259
  "type": {
307
- "text": "boolean"
260
+ "text": "ZeroGridPro"
308
261
  },
309
- "default": "false",
310
- "description": "If true, will enable row flashing for all rows for `add` transactions",
311
262
  "privacy": "public"
312
263
  },
313
264
  {
314
265
  "kind": "field",
315
- "name": "persistColumnStateKey",
266
+ "name": "datasource",
316
267
  "type": {
317
- "text": "string"
268
+ "text": "GridProGenesisDatasource"
318
269
  },
319
- "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.",
320
270
  "privacy": "public"
321
271
  },
322
272
  {
@@ -324,279 +274,108 @@
324
274
  "name": "gridOptions",
325
275
  "type": {
326
276
  "text": "GridOptions"
327
- },
328
- "description": "GridOptions to be passed down from application",
329
- "privacy": "public"
277
+ }
330
278
  },
331
279
  {
332
280
  "kind": "field",
333
281
  "name": "columns",
334
282
  "type": {
335
283
  "text": "ColDef[]"
336
- },
337
- "description": "Array which holds the column definitions.",
338
- "privacy": "public"
284
+ }
339
285
  },
340
286
  {
341
287
  "kind": "field",
342
288
  "name": "datasourceConfig",
343
289
  "type": {
344
290
  "text": "DatasourceConfiguration"
345
- },
346
- "description": "The configuration which is used when interacting with the resource on the backend",
347
- "privacy": "public"
291
+ }
348
292
  },
349
293
  {
350
294
  "kind": "field",
351
- "name": "formUiSchema",
295
+ "name": "actionButtonsConfig",
352
296
  "type": {
353
- "text": "any"
354
- }
297
+ "text": "array"
298
+ },
299
+ "default": "[]"
355
300
  },
356
301
  {
357
302
  "kind": "field",
358
- "name": "createFormUiSchema",
303
+ "name": "deleteEvent",
359
304
  "type": {
360
- "text": "any"
305
+ "text": "string"
361
306
  }
362
307
  },
363
308
  {
364
309
  "kind": "field",
365
- "name": "updateFormUiSchema",
310
+ "name": "updateEvent",
366
311
  "type": {
367
- "text": "any"
312
+ "text": "string"
368
313
  }
369
314
  },
370
315
  {
371
316
  "kind": "field",
372
- "name": "formRenderers",
317
+ "name": "connect",
373
318
  "type": {
374
- "text": "RendererEntry[]"
319
+ "text": "Connect"
375
320
  },
376
- "default": "renderers",
377
- "description": "Array with renderers used by foundation-forms",
378
- "privacy": "public"
321
+ "privacy": "protected"
379
322
  },
380
323
  {
381
- "kind": "field",
382
- "name": "selectedEntity",
383
- "type": {
384
- "text": "any"
385
- },
386
- "description": "Reference to the currently selected entity from the grid.",
387
- "privacy": "public"
324
+ "kind": "method",
325
+ "name": "onCellEditingStopped",
326
+ "privacy": "private",
327
+ "parameters": [
328
+ {
329
+ "name": "event",
330
+ "type": {
331
+ "text": "CellEditRequestEvent"
332
+ }
333
+ }
334
+ ]
388
335
  },
389
336
  {
390
- "kind": "field",
391
- "name": "editedEntity",
392
- "type": {
393
- "text": "any"
394
- },
395
- "description": "Disables the form while enabled to stop the user dispatching a large number of duplicate events",
396
- "privacy": "public"
337
+ "kind": "method",
338
+ "name": "handleFilterChanged",
339
+ "privacy": "private",
340
+ "parameters": [
341
+ {
342
+ "name": "e"
343
+ }
344
+ ]
397
345
  },
398
346
  {
399
- "kind": "field",
400
- "name": "submitting",
401
- "type": {
402
- "text": "boolean"
403
- }
347
+ "kind": "method",
348
+ "name": "handleFilterCleared",
349
+ "privacy": "private",
350
+ "parameters": [
351
+ {
352
+ "name": "e"
353
+ }
354
+ ]
404
355
  },
405
356
  {
406
- "kind": "field",
407
- "name": "defaultEntityValues",
408
- "type": {
409
- "text": "any"
410
- }
357
+ "kind": "method",
358
+ "name": "select",
359
+ "privacy": "private",
360
+ "parameters": [
361
+ {
362
+ "name": "e"
363
+ }
364
+ ]
411
365
  },
412
366
  {
413
367
  "kind": "field",
414
- "name": "editDialogTitle",
415
- "type": {
416
- "text": "string"
417
- },
418
- "description": "String which contains the text of the popup modal when the user is adding or editing an entity"
419
- },
420
- {
421
- "kind": "field",
422
- "name": "editModalVisible",
423
- "type": {
424
- "text": "boolean"
425
- },
426
- "default": "false"
427
- },
428
- {
429
- "kind": "method",
430
- "name": "editModalVisibleChanged"
431
- },
432
- {
433
- "kind": "field",
434
- "name": "editEntityModal",
435
- "type": {
436
- "text": "any"
437
- },
438
- "privacy": "public"
439
- },
440
- {
441
- "kind": "field",
442
- "name": "sizeColumnsToFit",
443
- "type": {
444
- "text": "boolean"
445
- }
446
- },
447
- {
448
- "kind": "field",
449
- "name": "enableFilterBar",
450
- "type": {
451
- "text": "boolean"
452
- }
453
- },
454
- {
455
- "kind": "field",
456
- "name": "hideEdit",
457
- "type": {
458
- "text": "boolean"
459
- },
460
- "default": "false"
461
- },
462
- {
463
- "kind": "field",
464
- "name": "hideDelete",
465
- "type": {
466
- "text": "boolean"
467
- },
468
- "default": "false"
469
- },
470
- {
471
- "kind": "field",
472
- "name": "enableSearchBar",
473
- "type": {
474
- "text": "boolean"
475
- },
476
- "default": "false"
477
- },
478
- {
479
- "kind": "field",
480
- "name": "headerCaseType",
481
- "type": {
482
- "text": "GridProCaseType"
483
- },
484
- "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
485
- "privacy": "public"
486
- },
487
- {
488
- "kind": "field",
489
- "name": "searchBarConfig",
490
- "type": {
491
- "text": "AvailableOption[]"
492
- }
493
- },
494
- {
495
- "kind": "field",
496
- "name": "modalPosition",
497
- "type": {
498
- "text": "'centre' | 'left' | 'right'"
499
- },
500
- "default": "'right'",
501
- "description": "Determines where the modal dialog will appear on screen",
502
- "privacy": "public"
368
+ "name": "edit",
369
+ "privacy": "private"
503
370
  },
504
371
  {
505
372
  "kind": "method",
506
- "name": "deepClone",
507
- "return": {
508
- "type": {
509
- "text": "Node"
510
- }
511
- },
512
- "description": "Override the deepClone method to ensure that observable attributes are cloned",
513
- "privacy": "public"
514
- },
515
- {
516
- "kind": "method",
517
- "name": "submitEntityChanges",
518
- "privacy": "public",
519
- "parameters": [
520
- {
521
- "name": "e",
522
- "type": {
523
- "text": "CustomEvent"
524
- },
525
- "description": "CustomEvent which contains the payload for the entity to submit to the backend\n\nEmits an event upon error"
526
- }
527
- ],
528
- "description": "Event handler for when the user submits the action for the currently open form, either editing or adding the entity"
529
- },
530
- {
531
- "kind": "method",
532
- "name": "readEntity",
533
- "privacy": "private",
534
- "parameters": [
535
- {
536
- "name": "e",
537
- "type": {
538
- "text": "CustomEvent"
539
- }
540
- }
541
- ]
542
- },
543
- {
544
- "kind": "method",
545
- "name": "closeModal",
546
- "privacy": "public"
547
- },
548
- {
549
- "kind": "field",
550
- "name": "headerTempalate",
551
- "readonly": true
552
- },
553
- {
554
- "kind": "method",
555
- "name": "searchChanged",
556
- "privacy": "public",
557
- "parameters": [
558
- {
559
- "name": "event",
560
- "type": {
561
- "text": "CustomEvent<Array<SelectedOption>>"
562
- }
563
- }
564
- ]
565
- },
566
- {
567
- "kind": "method",
568
- "name": "criteriaChanged",
569
- "privacy": "public",
570
- "parameters": [
571
- {
572
- "name": "e",
573
- "type": {
574
- "text": "CustomEvent<string>"
575
- }
576
- }
577
- ]
578
- },
579
- {
580
- "kind": "method",
581
- "name": "submitFailureNotification",
582
- "privacy": "public",
373
+ "name": "delete",
583
374
  "parameters": [
584
375
  {
585
- "name": "e",
586
- "type": {
587
- "text": "CustomEvent"
588
- }
376
+ "name": "e"
589
377
  }
590
378
  ]
591
- },
592
- {
593
- "kind": "method",
594
- "name": "confirmDelete"
595
- },
596
- {
597
- "kind": "method",
598
- "name": "showDeleteConfirmation",
599
- "privacy": "private"
600
379
  }
601
380
  ],
602
381
  "attributes": [
@@ -605,62 +384,37 @@
605
384
  "type": {
606
385
  "text": "string"
607
386
  },
608
- "description": "Name of the backend resource which contain the entities to manage",
387
+ "default": "''",
609
388
  "fieldName": "resourceName"
610
389
  },
611
390
  {
612
- "name": "readEvent",
613
- "type": {
614
- "text": "string"
615
- },
616
- "fieldName": "readEvent"
617
- },
618
- {
619
- "type": {
620
- "text": "boolean"
621
- },
622
- "fieldName": "readonly"
623
- },
624
- {
625
- "name": "updateEvent",
626
- "type": {
627
- "text": "string"
628
- },
629
- "description": "Name of the event handler on the Genesis server which handles updating the entity",
630
- "fieldName": "updateEvent"
631
- },
632
- {
633
- "name": "deleteEvent",
391
+ "name": "title",
634
392
  "type": {
635
393
  "text": "string"
636
394
  },
637
- "description": "Name of the event handler on the Genesis server which handles deleting the entity",
638
- "fieldName": "deleteEvent"
395
+ "default": "''",
396
+ "fieldName": "title"
639
397
  },
640
398
  {
641
- "name": "createEvent",
399
+ "name": "persist-column-state-key",
642
400
  "type": {
643
401
  "text": "string"
644
402
  },
645
- "description": "Name of the event handler on the Genesis server which handles creating an entity",
646
- "fieldName": "createEvent"
403
+ "fieldName": "persistColumnStateKey"
647
404
  },
648
405
  {
649
- "name": "title",
406
+ "name": "size-columns-to-fit",
650
407
  "type": {
651
- "text": "string"
408
+ "text": "boolean"
652
409
  },
653
- "description": "Title of the grid",
654
- "fieldName": "title"
410
+ "fieldName": "sizeColumnsToFit"
655
411
  },
656
412
  {
657
- "name": "entityLabel",
413
+ "name": "enable-filter-bar",
658
414
  "type": {
659
- "text": "string"
415
+ "text": "boolean"
660
416
  },
661
- "default": "''",
662
- "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
663
- "fieldName": "entityLabel"
417
+ "fieldName": "enableFilterBar"
664
418
  },
665
419
  {
666
420
  "name": "async-add",
@@ -668,7 +422,6 @@
668
422
  "text": "boolean"
669
423
  },
670
424
  "default": "false",
671
- "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
672
425
  "fieldName": "asyncAdd"
673
426
  },
674
427
  {
@@ -677,7 +430,6 @@
677
430
  "text": "boolean"
678
431
  },
679
432
  "default": "false",
680
- "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
681
433
  "fieldName": "asyncRemove"
682
434
  },
683
435
  {
@@ -686,7 +438,6 @@
686
438
  "text": "boolean"
687
439
  },
688
440
  "default": "true",
689
- "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
690
441
  "fieldName": "asyncUpdate"
691
442
  },
692
443
  {
@@ -695,7 +446,6 @@
695
446
  "text": "boolean"
696
447
  },
697
448
  "default": "false",
698
- "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
699
449
  "fieldName": "enableCellFlashing"
700
450
  },
701
451
  {
@@ -704,31 +454,8 @@
704
454
  "text": "boolean"
705
455
  },
706
456
  "default": "false",
707
- "description": "If true, will enable row flashing for all rows for `add` transactions",
708
457
  "fieldName": "enableRowFlashing"
709
458
  },
710
- {
711
- "name": "persist-column-state-key",
712
- "type": {
713
- "text": "string"
714
- },
715
- "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.",
716
- "fieldName": "persistColumnStateKey"
717
- },
718
- {
719
- "name": "size-columns-to-fit",
720
- "type": {
721
- "text": "boolean"
722
- },
723
- "fieldName": "sizeColumnsToFit"
724
- },
725
- {
726
- "name": "enable-filter-bar",
727
- "type": {
728
- "text": "boolean"
729
- },
730
- "fieldName": "enableFilterBar"
731
- },
732
459
  {
733
460
  "name": "hide-edit",
734
461
  "type": {
@@ -745,218 +472,159 @@
745
472
  "default": "false",
746
473
  "fieldName": "hideDelete"
747
474
  },
748
- {
749
- "name": "enable-search-bar",
750
- "type": {
751
- "text": "boolean"
752
- },
753
- "default": "false",
754
- "fieldName": "enableSearchBar"
755
- },
756
475
  {
757
476
  "name": "header-case-type",
758
477
  "type": {
759
478
  "text": "GridProCaseType"
760
479
  },
761
- "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
762
480
  "fieldName": "headerCaseType"
763
- },
764
- {
765
- "name": "modal-position",
766
- "type": {
767
- "text": "'centre' | 'left' | 'right'"
768
- },
769
- "default": "'right'",
770
- "description": "Determines where the modal dialog will appear on screen",
771
- "fieldName": "modalPosition"
772
- }
773
- ],
774
- "mixins": [
775
- {
776
- "name": "LifecycleMixin",
777
- "package": "@genesislcap/foundation-utils"
778
481
  }
779
482
  ],
780
483
  "superclass": {
781
484
  "name": "FASTElement",
782
485
  "package": "@microsoft/fast-element"
783
486
  },
784
- "tagName": "entity-management",
487
+ "tagName": "entity-list",
785
488
  "customElement": true
786
489
  }
787
490
  ],
788
491
  "exports": [
789
492
  {
790
493
  "kind": "js",
791
- "name": "EntityManagement",
494
+ "name": "List",
792
495
  "declaration": {
793
- "name": "EntityManagement",
794
- "module": "src/entities/entities.ts"
496
+ "name": "List",
497
+ "module": "src/list/list.ts"
795
498
  }
796
499
  },
797
500
  {
798
501
  "kind": "custom-element-definition",
799
- "name": "entity-management",
800
- "declaration": {
801
- "name": "EntityManagement",
802
- "module": "src/entities/entities.ts"
803
- }
804
- }
805
- ]
806
- },
807
- {
808
- "kind": "javascript-module",
809
- "path": "src/entities/index.ts",
810
- "declarations": [],
811
- "exports": [
812
- {
813
- "kind": "js",
814
- "name": "*",
815
- "declaration": {
816
- "name": "*",
817
- "package": "./entities"
818
- }
819
- },
820
- {
821
- "kind": "js",
822
- "name": "*",
823
- "declaration": {
824
- "name": "*",
825
- "package": "./entities.template"
826
- }
827
- },
828
- {
829
- "kind": "js",
830
- "name": "*",
831
- "declaration": {
832
- "name": "*",
833
- "package": "./entities.styles"
834
- }
835
- }
836
- ]
837
- },
838
- {
839
- "kind": "javascript-module",
840
- "path": "src/layouts/default.ts",
841
- "declarations": [
842
- {
843
- "kind": "variable",
844
- "name": "loginLayout",
845
- "default": "new FASTElementLayout(\n html`\n <div class=\"container\">\n <div class=\"content\">\n <slot></slot>\n </div>\n </div>\n `,\n baseLayoutCss,\n)"
846
- },
847
- {
848
- "kind": "variable",
849
- "name": "defaultLayout",
850
- "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)"
851
- }
852
- ],
853
- "exports": [
854
- {
855
- "kind": "js",
856
- "name": "loginLayout",
857
- "declaration": {
858
- "name": "loginLayout",
859
- "module": "src/layouts/default.ts"
860
- }
861
- },
862
- {
863
- "kind": "js",
864
- "name": "defaultLayout",
865
- "declaration": {
866
- "name": "defaultLayout",
867
- "module": "src/layouts/default.ts"
868
- }
869
- }
870
- ]
871
- },
872
- {
873
- "kind": "javascript-module",
874
- "path": "src/layouts/index.ts",
875
- "declarations": [],
876
- "exports": [
877
- {
878
- "kind": "js",
879
- "name": "*",
880
- "declaration": {
881
- "name": "*",
882
- "package": "./default"
883
- }
884
- }
885
- ]
886
- },
887
- {
888
- "kind": "javascript-module",
889
- "path": "src/list/index.ts",
890
- "declarations": [],
891
- "exports": [
892
- {
893
- "kind": "js",
894
- "name": "*",
502
+ "name": "entity-list",
895
503
  "declaration": {
896
- "name": "*",
897
- "package": "./list"
504
+ "name": "List",
505
+ "module": "src/list/list.ts"
898
506
  }
899
507
  }
900
508
  ]
901
509
  },
902
510
  {
903
511
  "kind": "javascript-module",
904
- "path": "src/list/list.styles.ts",
512
+ "path": "src/entities/entities.styles.ts",
905
513
  "declarations": [
906
514
  {
907
515
  "kind": "variable",
908
- "name": "listStyles",
909
- "default": "css`\n :host {\n contain: content;\n }\n\n :host,\n fast-router {\n display: flex;\n flex-direction: column;\n width: 100%;\n height: 100%;\n }\n\n .container {\n display: flex;\n flex-direction: column;\n height: inherit;\n width: 100%;\n }\n`"
516
+ "name": "styles",
517
+ "default": "css`\n :host {\n contain: content;\n }\n\n .container {\n display: flex;\n flex-direction: column;\n height: 100%;\n }\n\n foundation-form {\n height: 100%;\n overflow-y: auto;\n display: flex;\n flex-direction: column;\n justify-content: space-between;\n }\n\n .title {\n margin-left: 1px;\n }\n\n :host::part(header) {\n display: flex;\n justify-content: space-between;\n align-items: center;\n }\n\n .search-container {\n display: flex;\n align-items: center;\n }\n\n .search-container zero-search-bar {\n width: 500px;\n }\n`",
518
+ "description": "Defines the css of the entity component as an ElementStyles object"
910
519
  }
911
520
  ],
912
521
  "exports": [
913
522
  {
914
523
  "kind": "js",
915
- "name": "listStyles",
524
+ "name": "styles",
916
525
  "declaration": {
917
- "name": "listStyles",
918
- "module": "src/list/list.styles.ts"
526
+ "name": "styles",
527
+ "module": "src/entities/entities.styles.ts"
919
528
  }
920
529
  }
921
530
  ]
922
531
  },
923
532
  {
924
533
  "kind": "javascript-module",
925
- "path": "src/list/list.template.ts",
534
+ "path": "src/entities/entities.template.ts",
926
535
  "declarations": [
927
536
  {
928
537
  "kind": "variable",
929
- "name": "listTemplate",
930
- "default": "html<List>`\n <div class=\"container\">\n ${when(\n (x) => x.enableFilterBar,\n html<List>`\n <zero-filter-bar\n resource=${(x) => x.resourceName}\n only=${(x) => x.columns?.map((colDef) => colDef.field).filter((field) => !!field)}\n labels=${(x) => x.columns?.map((colDef) => colDef.headerName || '')}\n target=\"datasource\"\n ></zero-filter-bar>\n `,\n )}\n <zero-grid-pro\n ${ref('grid')}\n auto-cell-renderer-by-type\n rowSelection=\"single\"\n rowHeight=\"36\"\n headerHeight=\"36\"\n persist-column-state-key=${(x) => x.persistColumnStateKey}\n ?only-template-col-defs=${(x) => !!x.columns}\n readOnlyEdit=\"true\"\n tooltipMouseTrack=\"true\"\n tooltipShowDelay=\"0\"\n async-add=${(x) => x.asyncAdd}\n async-remove=${(x) => x.asyncRemove}\n async-update=${(x) => x.asyncUpdate}\n enable-cell-flashing=${(x) => x.enableCellFlashing}\n enable-row-flashing=${(x) => x.enableRowFlashing}\n header-case-type=${(x) => x.headerCaseType}\n >\n <grid-pro-genesis-datasource\n ${ref('datasource')}\n :deferredGridOptions=${(x) => x.gridOptions}\n criteria=${(x) => x.datasourceConfig?.criteria}\n fields=${(x) => x.datasourceConfig?.fields}\n is-snapshot=${(x) => x.datasourceConfig?.isSnapshot}\n max-rows=${(x) => x.datasourceConfig?.maxRows}\n max-view=${(x) => x.datasourceConfig?.maxView}\n moving-view=${(x) => x.datasourceConfig?.movingView}\n order-by=${(x) => x.datasourceConfig?.orderBy}\n polling-interval=${(x) => x.datasourceConfig?.pollingInterval}\n resource-name=${(x) => x.resourceName}\n reverse=${(x) => x.datasourceConfig?.reverse}\n ></grid-pro-genesis-datasource>\n ${repeat(\n (x) => x.columns,\n html`\n <grid-pro-column :definition=${(x) => x}></grid-pro-column>\n `,\n )}\n ${repeat(\n (x) => x.actionButtonsConfig,\n html`\n <grid-pro-column :definition=${(x) => x}></grid-pro-column>\n `,\n )}\n </zero-grid-pro>\n </div>\n`"
538
+ "name": "template",
539
+ "default": "html<EntityManagement>`\n <div class=\"container\">\n <slot name=\"header\" part=\"header\">${(x) => x.headerTempalate}</slot>\n <entity-list\n title=${(x) => x.title}\n async-add=${(x) => x.asyncAdd}\n async-remove=${(x) => x.asyncRemove}\n async-update=${(x) => x.asyncUpdate}\n enable-cell-flashing=${(x) => x.enableCellFlashing}\n enable-row-flashing=${(x) => x.enableRowFlashing}\n persist-column-state-key=${(x) => x.persistColumnStateKey}\n size-columns-to-fit=${(x) => x.sizeColumnsToFit}\n enable-filter-bar=${(x) => x.enableFilterBar}\n resourceName=${(x) => x.resourceName}\n :deleteEvent=${(x) => x.deleteEvent}\n :updateEvent=${(x) => x.updateEvent}\n :gridOptions=${(x) => x.gridOptions}\n :columns=${(x) => x.columns}\n :datasourceConfig=${(x) => x.datasourceConfig}\n data-test-id=\"entity-list\"\n hide-edit=${(x) => x.hideEdit}\n hide-delete=${(x) => x.hideDelete}\n header-case-type=${(x) => x.headerCaseType}\n >\n <slot name=\"header\" slot=\"header\">${defaultHeader}</slot>\n </entity-list>\n <zero-modal\n ${ref('editEntityModal')}\n position=${(x) => x.modalPosition}\n :onCloseCallback=${(x) => x.closeModal.bind(x)}\n data-test-id=\"edit-entity-modal\"\n >\n <div slot=\"top\" data-test-id=\"dialog-title\">${(x) => x.editDialogTitle}</div>\n\n <slot name=\"edit\">\n ${when(\n (x) => x.editModalVisible,\n html<EntityManagement>`\n <foundation-form\n part=\"form\"\n :renderers=${(x) => x.formRenderers}\n resourceName=${(x) => x.formResourceName}\n :data=${(x) => x.editedEntity}\n :uischema=${(x) => x.formUiSchema}\n readonly=${(x) => x.readonly}\n @submit-success=${(x, c) => x.submitEntityChanges(c.event as CustomEvent)}\n ></foundation-form>\n `,\n )}\n </slot>\n </zero-modal>\n </div>\n`",
540
+ "description": "Defines the html of the entity component as a ViewTemplate object"
931
541
  }
932
542
  ],
933
543
  "exports": [
934
544
  {
935
545
  "kind": "js",
936
- "name": "listTemplate",
546
+ "name": "template",
937
547
  "declaration": {
938
- "name": "listTemplate",
939
- "module": "src/list/list.template.ts"
548
+ "name": "template",
549
+ "module": "src/entities/entities.template.ts"
940
550
  }
941
551
  }
942
552
  ]
943
553
  },
944
554
  {
945
555
  "kind": "javascript-module",
946
- "path": "src/list/list.ts",
556
+ "path": "src/entities/entities.ts",
947
557
  "declarations": [
948
558
  {
949
559
  "kind": "class",
950
- "description": "",
951
- "name": "List",
560
+ "description": "Main class which defines the entity management functionality",
561
+ "name": "EntityManagement",
952
562
  "members": [
563
+ {
564
+ "kind": "field",
565
+ "name": "connect",
566
+ "type": {
567
+ "text": "Connect"
568
+ },
569
+ "privacy": "protected",
570
+ "description": "DI connect object which is used to interact with the backend."
571
+ },
953
572
  {
954
573
  "kind": "field",
955
574
  "name": "resourceName",
956
575
  "type": {
957
576
  "text": "string"
958
577
  },
959
- "default": "''"
578
+ "description": "Name of the backend resource which contain the entities to manage",
579
+ "privacy": "public"
580
+ },
581
+ {
582
+ "kind": "field",
583
+ "name": "readEvent",
584
+ "type": {
585
+ "text": "string"
586
+ }
587
+ },
588
+ {
589
+ "kind": "field",
590
+ "name": "readEventFn",
591
+ "type": {
592
+ "text": "(...args) => {}"
593
+ }
594
+ },
595
+ {
596
+ "kind": "field",
597
+ "name": "readonly",
598
+ "type": {
599
+ "text": "boolean"
600
+ }
601
+ },
602
+ {
603
+ "kind": "field",
604
+ "name": "updateEvent",
605
+ "type": {
606
+ "text": "string"
607
+ },
608
+ "description": "Name of the event handler on the Genesis server which handles updating the entity",
609
+ "privacy": "public"
610
+ },
611
+ {
612
+ "kind": "field",
613
+ "name": "deleteEvent",
614
+ "type": {
615
+ "text": "string"
616
+ },
617
+ "description": "Name of the event handler on the Genesis server which handles deleting the entity",
618
+ "privacy": "public"
619
+ },
620
+ {
621
+ "kind": "field",
622
+ "name": "createEvent",
623
+ "type": {
624
+ "text": "string"
625
+ },
626
+ "description": "Name of the event handler on the Genesis server which handles creating an entity",
627
+ "privacy": "public"
960
628
  },
961
629
  {
962
630
  "kind": "field",
@@ -964,215 +632,356 @@
964
632
  "type": {
965
633
  "text": "string"
966
634
  },
967
- "default": "''"
635
+ "description": "Title of the grid",
636
+ "privacy": "public"
968
637
  },
969
638
  {
970
639
  "kind": "field",
971
- "name": "persistColumnStateKey",
640
+ "name": "entityLabel",
972
641
  "type": {
973
642
  "text": "string"
974
- }
643
+ },
644
+ "default": "''",
645
+ "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
646
+ "privacy": "public"
975
647
  },
976
648
  {
977
649
  "kind": "field",
978
- "name": "sizeColumnsToFit",
650
+ "name": "asyncAdd",
979
651
  "type": {
980
652
  "text": "boolean"
981
- }
653
+ },
654
+ "default": "false",
655
+ "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
656
+ "privacy": "public"
982
657
  },
983
658
  {
984
659
  "kind": "field",
985
- "name": "enableFilterBar",
660
+ "name": "asyncRemove",
986
661
  "type": {
987
662
  "text": "boolean"
988
- }
663
+ },
664
+ "default": "false",
665
+ "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
666
+ "privacy": "public"
989
667
  },
990
668
  {
991
669
  "kind": "field",
992
- "name": "asyncAdd",
670
+ "name": "asyncUpdate",
993
671
  "type": {
994
672
  "text": "boolean"
995
673
  },
996
- "default": "false"
674
+ "default": "true",
675
+ "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
676
+ "privacy": "public"
997
677
  },
998
678
  {
999
679
  "kind": "field",
1000
- "name": "asyncRemove",
680
+ "name": "enableCellFlashing",
1001
681
  "type": {
1002
682
  "text": "boolean"
1003
683
  },
1004
- "default": "false"
684
+ "default": "false",
685
+ "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
686
+ "privacy": "public"
1005
687
  },
1006
688
  {
1007
689
  "kind": "field",
1008
- "name": "asyncUpdate",
690
+ "name": "enableRowFlashing",
1009
691
  "type": {
1010
692
  "text": "boolean"
1011
693
  },
1012
- "default": "true"
694
+ "default": "false",
695
+ "description": "If true, will enable row flashing for all rows for `add` transactions",
696
+ "privacy": "public"
1013
697
  },
1014
698
  {
1015
699
  "kind": "field",
1016
- "name": "enableCellFlashing",
700
+ "name": "persistColumnStateKey",
1017
701
  "type": {
1018
- "text": "boolean"
702
+ "text": "string"
1019
703
  },
1020
- "default": "false"
704
+ "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.",
705
+ "privacy": "public"
1021
706
  },
1022
707
  {
1023
708
  "kind": "field",
1024
- "name": "enableRowFlashing",
709
+ "name": "gridOptions",
1025
710
  "type": {
1026
- "text": "boolean"
711
+ "text": "GridOptions"
1027
712
  },
1028
- "default": "false"
713
+ "description": "GridOptions to be passed down from application",
714
+ "privacy": "public"
1029
715
  },
1030
716
  {
1031
717
  "kind": "field",
1032
- "name": "hideEdit",
718
+ "name": "columns",
1033
719
  "type": {
1034
- "text": "boolean"
720
+ "text": "ColDef[]"
1035
721
  },
1036
- "default": "false"
722
+ "description": "Array which holds the column definitions.",
723
+ "privacy": "public"
1037
724
  },
1038
725
  {
1039
726
  "kind": "field",
1040
- "name": "hideDelete",
727
+ "name": "datasourceConfig",
1041
728
  "type": {
1042
- "text": "boolean"
729
+ "text": "DatasourceConfiguration"
1043
730
  },
1044
- "default": "false"
731
+ "description": "The configuration which is used when interacting with the resource on the backend",
732
+ "privacy": "public"
1045
733
  },
1046
734
  {
1047
735
  "kind": "field",
1048
- "name": "headerCaseType",
736
+ "name": "formUiSchema",
1049
737
  "type": {
1050
- "text": "GridProCaseType"
738
+ "text": "any"
1051
739
  }
1052
740
  },
1053
741
  {
1054
742
  "kind": "field",
1055
- "name": "grid",
743
+ "name": "createFormUiSchema",
1056
744
  "type": {
1057
- "text": "ZeroGridPro"
745
+ "text": "any"
746
+ }
747
+ },
748
+ {
749
+ "kind": "field",
750
+ "name": "updateFormUiSchema",
751
+ "type": {
752
+ "text": "any"
753
+ }
754
+ },
755
+ {
756
+ "kind": "field",
757
+ "name": "formRenderers",
758
+ "type": {
759
+ "text": "RendererEntry[]"
1058
760
  },
761
+ "default": "renderers",
762
+ "description": "Array with renderers used by foundation-forms",
1059
763
  "privacy": "public"
1060
764
  },
1061
765
  {
1062
766
  "kind": "field",
1063
- "name": "datasource",
767
+ "name": "selectedEntity",
1064
768
  "type": {
1065
- "text": "GridProGenesisDatasource"
769
+ "text": "any"
1066
770
  },
771
+ "description": "Reference to the currently selected entity from the grid.",
1067
772
  "privacy": "public"
1068
773
  },
1069
774
  {
1070
775
  "kind": "field",
1071
- "name": "gridOptions",
776
+ "name": "editedEntity",
1072
777
  "type": {
1073
- "text": "GridOptions"
1074
- }
778
+ "text": "any"
779
+ },
780
+ "description": "Disables the form while enabled to stop the user dispatching a large number of duplicate events",
781
+ "privacy": "public"
1075
782
  },
1076
783
  {
1077
784
  "kind": "field",
1078
- "name": "columns",
785
+ "name": "submitting",
1079
786
  "type": {
1080
- "text": "ColDef[]"
787
+ "text": "boolean"
1081
788
  }
1082
789
  },
1083
790
  {
1084
791
  "kind": "field",
1085
- "name": "datasourceConfig",
792
+ "name": "defaultEntityValues",
1086
793
  "type": {
1087
- "text": "DatasourceConfiguration"
794
+ "text": "any"
1088
795
  }
1089
796
  },
1090
797
  {
1091
798
  "kind": "field",
1092
- "name": "actionButtonsConfig",
799
+ "name": "editDialogTitle",
1093
800
  "type": {
1094
- "text": "array"
801
+ "text": "string"
1095
802
  },
1096
- "default": "[]"
803
+ "description": "String which contains the text of the popup modal when the user is adding or editing an entity"
1097
804
  },
1098
805
  {
1099
806
  "kind": "field",
1100
- "name": "deleteEvent",
807
+ "name": "editModalVisible",
1101
808
  "type": {
1102
- "text": "string"
809
+ "text": "boolean"
810
+ },
811
+ "default": "false"
812
+ },
813
+ {
814
+ "kind": "method",
815
+ "name": "editModalVisibleChanged"
816
+ },
817
+ {
818
+ "kind": "field",
819
+ "name": "editEntityModal",
820
+ "type": {
821
+ "text": "any"
822
+ },
823
+ "privacy": "public"
824
+ },
825
+ {
826
+ "kind": "field",
827
+ "name": "sizeColumnsToFit",
828
+ "type": {
829
+ "text": "boolean"
1103
830
  }
1104
831
  },
1105
832
  {
1106
833
  "kind": "field",
1107
- "name": "updateEvent",
834
+ "name": "enableFilterBar",
1108
835
  "type": {
1109
- "text": "string"
836
+ "text": "boolean"
1110
837
  }
1111
838
  },
1112
839
  {
1113
840
  "kind": "field",
1114
- "name": "connect",
841
+ "name": "hideEdit",
1115
842
  "type": {
1116
- "text": "Connect"
843
+ "text": "boolean"
1117
844
  },
1118
- "privacy": "protected"
845
+ "default": "false"
846
+ },
847
+ {
848
+ "kind": "field",
849
+ "name": "hideDelete",
850
+ "type": {
851
+ "text": "boolean"
852
+ },
853
+ "default": "false"
854
+ },
855
+ {
856
+ "kind": "field",
857
+ "name": "enableSearchBar",
858
+ "type": {
859
+ "text": "boolean"
860
+ },
861
+ "default": "false"
862
+ },
863
+ {
864
+ "kind": "field",
865
+ "name": "headerCaseType",
866
+ "type": {
867
+ "text": "GridProCaseType"
868
+ },
869
+ "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
870
+ "privacy": "public"
871
+ },
872
+ {
873
+ "kind": "field",
874
+ "name": "searchBarConfig",
875
+ "type": {
876
+ "text": "AvailableOption[]"
877
+ }
878
+ },
879
+ {
880
+ "kind": "field",
881
+ "name": "modalPosition",
882
+ "type": {
883
+ "text": "'centre' | 'left' | 'right'"
884
+ },
885
+ "default": "'right'",
886
+ "description": "Determines where the modal dialog will appear on screen",
887
+ "privacy": "public"
1119
888
  },
1120
889
  {
1121
890
  "kind": "method",
1122
- "name": "onCellEditingStopped",
891
+ "name": "deepClone",
892
+ "return": {
893
+ "type": {
894
+ "text": "Node"
895
+ }
896
+ },
897
+ "description": "Override the deepClone method to ensure that observable attributes are cloned",
898
+ "privacy": "public"
899
+ },
900
+ {
901
+ "kind": "method",
902
+ "name": "submitEntityChanges",
903
+ "privacy": "public",
904
+ "parameters": [
905
+ {
906
+ "name": "e",
907
+ "type": {
908
+ "text": "CustomEvent"
909
+ },
910
+ "description": "CustomEvent which contains the payload for the entity to submit to the backend\n\nEmits an event upon error"
911
+ }
912
+ ],
913
+ "description": "Event handler for when the user submits the action for the currently open form, either editing or adding the entity"
914
+ },
915
+ {
916
+ "kind": "method",
917
+ "name": "readEntity",
1123
918
  "privacy": "private",
1124
919
  "parameters": [
1125
920
  {
1126
- "name": "event",
921
+ "name": "e",
1127
922
  "type": {
1128
- "text": "CellEditRequestEvent"
923
+ "text": "CustomEvent"
1129
924
  }
1130
925
  }
1131
926
  ]
1132
927
  },
1133
928
  {
1134
929
  "kind": "method",
1135
- "name": "handleFilterChanged",
1136
- "privacy": "private",
930
+ "name": "closeModal",
931
+ "privacy": "public"
932
+ },
933
+ {
934
+ "kind": "field",
935
+ "name": "headerTempalate",
936
+ "readonly": true
937
+ },
938
+ {
939
+ "kind": "method",
940
+ "name": "searchChanged",
941
+ "privacy": "public",
1137
942
  "parameters": [
1138
943
  {
1139
- "name": "e"
944
+ "name": "event",
945
+ "type": {
946
+ "text": "CustomEvent<Array<SelectedOption>>"
947
+ }
1140
948
  }
1141
949
  ]
1142
950
  },
1143
951
  {
1144
952
  "kind": "method",
1145
- "name": "handleFilterCleared",
1146
- "privacy": "private",
953
+ "name": "criteriaChanged",
954
+ "privacy": "public",
1147
955
  "parameters": [
1148
956
  {
1149
- "name": "e"
957
+ "name": "e",
958
+ "type": {
959
+ "text": "CustomEvent<string>"
960
+ }
1150
961
  }
1151
962
  ]
1152
963
  },
1153
964
  {
1154
965
  "kind": "method",
1155
- "name": "select",
1156
- "privacy": "private",
966
+ "name": "submitFailureNotification",
967
+ "privacy": "public",
1157
968
  "parameters": [
1158
969
  {
1159
- "name": "e"
970
+ "name": "e",
971
+ "type": {
972
+ "text": "CustomEvent"
973
+ }
1160
974
  }
1161
975
  ]
1162
976
  },
1163
977
  {
1164
- "kind": "field",
1165
- "name": "edit",
1166
- "privacy": "private"
978
+ "kind": "method",
979
+ "name": "confirmDelete"
1167
980
  },
1168
981
  {
1169
982
  "kind": "method",
1170
- "name": "delete",
1171
- "parameters": [
1172
- {
1173
- "name": "e"
1174
- }
1175
- ]
983
+ "name": "showDeleteConfirmation",
984
+ "privacy": "private"
1176
985
  }
1177
986
  ],
1178
987
  "attributes": [
@@ -1181,37 +990,62 @@
1181
990
  "type": {
1182
991
  "text": "string"
1183
992
  },
1184
- "default": "''",
993
+ "description": "Name of the backend resource which contain the entities to manage",
1185
994
  "fieldName": "resourceName"
1186
995
  },
1187
996
  {
1188
- "name": "title",
997
+ "name": "readEvent",
1189
998
  "type": {
1190
999
  "text": "string"
1191
1000
  },
1192
- "default": "''",
1193
- "fieldName": "title"
1001
+ "fieldName": "readEvent"
1194
1002
  },
1195
1003
  {
1196
- "name": "persist-column-state-key",
1004
+ "type": {
1005
+ "text": "boolean"
1006
+ },
1007
+ "fieldName": "readonly"
1008
+ },
1009
+ {
1010
+ "name": "updateEvent",
1197
1011
  "type": {
1198
1012
  "text": "string"
1199
1013
  },
1200
- "fieldName": "persistColumnStateKey"
1014
+ "description": "Name of the event handler on the Genesis server which handles updating the entity",
1015
+ "fieldName": "updateEvent"
1201
1016
  },
1202
1017
  {
1203
- "name": "size-columns-to-fit",
1018
+ "name": "deleteEvent",
1204
1019
  "type": {
1205
- "text": "boolean"
1020
+ "text": "string"
1206
1021
  },
1207
- "fieldName": "sizeColumnsToFit"
1022
+ "description": "Name of the event handler on the Genesis server which handles deleting the entity",
1023
+ "fieldName": "deleteEvent"
1208
1024
  },
1209
1025
  {
1210
- "name": "enable-filter-bar",
1026
+ "name": "createEvent",
1211
1027
  "type": {
1212
- "text": "boolean"
1028
+ "text": "string"
1213
1029
  },
1214
- "fieldName": "enableFilterBar"
1030
+ "description": "Name of the event handler on the Genesis server which handles creating an entity",
1031
+ "fieldName": "createEvent"
1032
+ },
1033
+ {
1034
+ "name": "title",
1035
+ "type": {
1036
+ "text": "string"
1037
+ },
1038
+ "description": "Title of the grid",
1039
+ "fieldName": "title"
1040
+ },
1041
+ {
1042
+ "name": "entityLabel",
1043
+ "type": {
1044
+ "text": "string"
1045
+ },
1046
+ "default": "''",
1047
+ "description": "Label for the entity which has usages such as being shown in the title of the modal wen editing the entity",
1048
+ "fieldName": "entityLabel"
1215
1049
  },
1216
1050
  {
1217
1051
  "name": "async-add",
@@ -1219,6 +1053,7 @@
1219
1053
  "text": "boolean"
1220
1054
  },
1221
1055
  "default": "false",
1056
+ "description": "Whether to use the `applyTransactionAsync` function for *add* transactions",
1222
1057
  "fieldName": "asyncAdd"
1223
1058
  },
1224
1059
  {
@@ -1227,6 +1062,7 @@
1227
1062
  "text": "boolean"
1228
1063
  },
1229
1064
  "default": "false",
1065
+ "description": "Whether to use the `applyTransactionAsync` function for *remove* transactions",
1230
1066
  "fieldName": "asyncRemove"
1231
1067
  },
1232
1068
  {
@@ -1235,6 +1071,7 @@
1235
1071
  "text": "boolean"
1236
1072
  },
1237
1073
  "default": "true",
1074
+ "description": "Whether to use the `applyTransactionAsync` function for *update* transactions",
1238
1075
  "fieldName": "asyncUpdate"
1239
1076
  },
1240
1077
  {
@@ -1243,6 +1080,7 @@
1243
1080
  "text": "boolean"
1244
1081
  },
1245
1082
  "default": "false",
1083
+ "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef",
1246
1084
  "fieldName": "enableCellFlashing"
1247
1085
  },
1248
1086
  {
@@ -1251,8 +1089,31 @@
1251
1089
  "text": "boolean"
1252
1090
  },
1253
1091
  "default": "false",
1092
+ "description": "If true, will enable row flashing for all rows for `add` transactions",
1254
1093
  "fieldName": "enableRowFlashing"
1255
1094
  },
1095
+ {
1096
+ "name": "persist-column-state-key",
1097
+ "type": {
1098
+ "text": "string"
1099
+ },
1100
+ "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.",
1101
+ "fieldName": "persistColumnStateKey"
1102
+ },
1103
+ {
1104
+ "name": "size-columns-to-fit",
1105
+ "type": {
1106
+ "text": "boolean"
1107
+ },
1108
+ "fieldName": "sizeColumnsToFit"
1109
+ },
1110
+ {
1111
+ "name": "enable-filter-bar",
1112
+ "type": {
1113
+ "text": "boolean"
1114
+ },
1115
+ "fieldName": "enableFilterBar"
1116
+ },
1256
1117
  {
1257
1118
  "name": "hide-edit",
1258
1119
  "type": {
@@ -1269,37 +1130,176 @@
1269
1130
  "default": "false",
1270
1131
  "fieldName": "hideDelete"
1271
1132
  },
1133
+ {
1134
+ "name": "enable-search-bar",
1135
+ "type": {
1136
+ "text": "boolean"
1137
+ },
1138
+ "default": "false",
1139
+ "fieldName": "enableSearchBar"
1140
+ },
1272
1141
  {
1273
1142
  "name": "header-case-type",
1274
1143
  "type": {
1275
1144
  "text": "GridProCaseType"
1276
1145
  },
1146
+ "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.",
1277
1147
  "fieldName": "headerCaseType"
1148
+ },
1149
+ {
1150
+ "name": "modal-position",
1151
+ "type": {
1152
+ "text": "'centre' | 'left' | 'right'"
1153
+ },
1154
+ "default": "'right'",
1155
+ "description": "Determines where the modal dialog will appear on screen",
1156
+ "fieldName": "modalPosition"
1157
+ }
1158
+ ],
1159
+ "mixins": [
1160
+ {
1161
+ "name": "LifecycleMixin",
1162
+ "package": "@genesislcap/foundation-utils"
1278
1163
  }
1279
1164
  ],
1280
1165
  "superclass": {
1281
1166
  "name": "FASTElement",
1282
1167
  "package": "@microsoft/fast-element"
1283
1168
  },
1284
- "tagName": "entity-list",
1169
+ "tagName": "entity-management",
1285
1170
  "customElement": true
1286
1171
  }
1287
1172
  ],
1288
1173
  "exports": [
1289
1174
  {
1290
1175
  "kind": "js",
1291
- "name": "List",
1176
+ "name": "EntityManagement",
1292
1177
  "declaration": {
1293
- "name": "List",
1294
- "module": "src/list/list.ts"
1178
+ "name": "EntityManagement",
1179
+ "module": "src/entities/entities.ts"
1295
1180
  }
1296
1181
  },
1297
1182
  {
1298
1183
  "kind": "custom-element-definition",
1299
- "name": "entity-list",
1184
+ "name": "entity-management",
1300
1185
  "declaration": {
1301
- "name": "List",
1302
- "module": "src/list/list.ts"
1186
+ "name": "EntityManagement",
1187
+ "module": "src/entities/entities.ts"
1188
+ }
1189
+ }
1190
+ ]
1191
+ },
1192
+ {
1193
+ "kind": "javascript-module",
1194
+ "path": "src/entities/index.ts",
1195
+ "declarations": [],
1196
+ "exports": [
1197
+ {
1198
+ "kind": "js",
1199
+ "name": "*",
1200
+ "declaration": {
1201
+ "name": "*",
1202
+ "package": "./entities"
1203
+ }
1204
+ },
1205
+ {
1206
+ "kind": "js",
1207
+ "name": "*",
1208
+ "declaration": {
1209
+ "name": "*",
1210
+ "package": "./entities.template"
1211
+ }
1212
+ },
1213
+ {
1214
+ "kind": "js",
1215
+ "name": "*",
1216
+ "declaration": {
1217
+ "name": "*",
1218
+ "package": "./entities.styles"
1219
+ }
1220
+ }
1221
+ ]
1222
+ },
1223
+ {
1224
+ "kind": "javascript-module",
1225
+ "path": "src/components/components.ts",
1226
+ "declarations": [
1227
+ {
1228
+ "kind": "function",
1229
+ "name": "loadRemotes"
1230
+ }
1231
+ ],
1232
+ "exports": [
1233
+ {
1234
+ "kind": "js",
1235
+ "name": "loadRemotes",
1236
+ "declaration": {
1237
+ "name": "loadRemotes",
1238
+ "module": "src/components/components.ts"
1239
+ }
1240
+ }
1241
+ ]
1242
+ },
1243
+ {
1244
+ "kind": "javascript-module",
1245
+ "path": "src/components/index.ts",
1246
+ "declarations": [],
1247
+ "exports": [
1248
+ {
1249
+ "kind": "js",
1250
+ "name": "*",
1251
+ "declaration": {
1252
+ "name": "*",
1253
+ "package": "./components"
1254
+ }
1255
+ }
1256
+ ]
1257
+ },
1258
+ {
1259
+ "kind": "javascript-module",
1260
+ "path": "src/layouts/default.ts",
1261
+ "declarations": [
1262
+ {
1263
+ "kind": "variable",
1264
+ "name": "loginLayout",
1265
+ "default": "new FASTElementLayout(\n html`\n <div class=\"container\">\n <div class=\"content\">\n <slot></slot>\n </div>\n </div>\n `,\n baseLayoutCss,\n)"
1266
+ },
1267
+ {
1268
+ "kind": "variable",
1269
+ "name": "defaultLayout",
1270
+ "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)"
1271
+ }
1272
+ ],
1273
+ "exports": [
1274
+ {
1275
+ "kind": "js",
1276
+ "name": "loginLayout",
1277
+ "declaration": {
1278
+ "name": "loginLayout",
1279
+ "module": "src/layouts/default.ts"
1280
+ }
1281
+ },
1282
+ {
1283
+ "kind": "js",
1284
+ "name": "defaultLayout",
1285
+ "declaration": {
1286
+ "name": "defaultLayout",
1287
+ "module": "src/layouts/default.ts"
1288
+ }
1289
+ }
1290
+ ]
1291
+ },
1292
+ {
1293
+ "kind": "javascript-module",
1294
+ "path": "src/layouts/index.ts",
1295
+ "declarations": [],
1296
+ "exports": [
1297
+ {
1298
+ "kind": "js",
1299
+ "name": "*",
1300
+ "declaration": {
1301
+ "name": "*",
1302
+ "package": "./default"
1303
1303
  }
1304
1304
  }
1305
1305
  ]