@genesislcap/foundation-entity-management 11.3.0

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 (114) hide show
  1. package/README.md +266 -0
  2. package/dist/dts/entities/entities.d.ts +550 -0
  3. package/dist/dts/entities/entities.d.ts.map +1 -0
  4. package/dist/dts/entities/entities.styles.d.ts +10 -0
  5. package/dist/dts/entities/entities.styles.d.ts.map +1 -0
  6. package/dist/dts/entities/entities.template.d.ts +7 -0
  7. package/dist/dts/entities/entities.template.d.ts.map +1 -0
  8. package/dist/dts/entities/index.d.ts +4 -0
  9. package/dist/dts/entities/index.d.ts.map +1 -0
  10. package/dist/dts/index.d.ts +5 -0
  11. package/dist/dts/index.d.ts.map +1 -0
  12. package/dist/dts/index.federated.d.ts +1 -0
  13. package/dist/dts/index.federated.d.ts.map +1 -0
  14. package/dist/dts/list/index.d.ts +2 -0
  15. package/dist/dts/list/index.d.ts.map +1 -0
  16. package/dist/dts/list/list.d.ts +29 -0
  17. package/dist/dts/list/list.d.ts.map +1 -0
  18. package/dist/dts/list/list.styles.d.ts +2 -0
  19. package/dist/dts/list/list.styles.d.ts.map +1 -0
  20. package/dist/dts/list/list.template.d.ts +26 -0
  21. package/dist/dts/list/list.template.d.ts.map +1 -0
  22. package/dist/dts/profiles/editProfileSchema.d.ts +19 -0
  23. package/dist/dts/profiles/editProfileSchema.d.ts.map +1 -0
  24. package/dist/dts/profiles/profiles.d.ts +43 -0
  25. package/dist/dts/profiles/profiles.d.ts.map +1 -0
  26. package/dist/dts/types.d.ts +3 -0
  27. package/dist/dts/types.d.ts.map +1 -0
  28. package/dist/dts/users/users.d.ts +566 -0
  29. package/dist/dts/users/users.d.ts.map +1 -0
  30. package/dist/dts/users/users.template.d.ts +3 -0
  31. package/dist/dts/users/users.template.d.ts.map +1 -0
  32. package/dist/dts/utils/formatting.d.ts +7 -0
  33. package/dist/dts/utils/formatting.d.ts.map +1 -0
  34. package/dist/dts/utils/index.d.ts +2 -0
  35. package/dist/dts/utils/index.d.ts.map +1 -0
  36. package/dist/esm/entities/entities.js +296 -0
  37. package/dist/esm/entities/entities.styles.js +29 -0
  38. package/dist/esm/entities/entities.template.js +43 -0
  39. package/dist/esm/entities/index.js +3 -0
  40. package/dist/esm/index.federated.js +1 -0
  41. package/dist/esm/index.js +4 -0
  42. package/dist/esm/list/index.js +1 -0
  43. package/dist/esm/list/list.js +111 -0
  44. package/dist/esm/list/list.styles.js +27 -0
  45. package/dist/esm/list/list.template.js +77 -0
  46. package/dist/esm/profiles/editProfileSchema.js +40 -0
  47. package/dist/esm/profiles/profiles.js +88 -0
  48. package/dist/esm/types.js +3 -0
  49. package/dist/esm/users/users.js +302 -0
  50. package/dist/esm/users/users.template.js +90 -0
  51. package/dist/esm/utils/formatting.js +6 -0
  52. package/dist/esm/utils/index.js +1 -0
  53. package/dist/foundation-entity-management.api.json +1727 -0
  54. package/dist/foundation-entity-management.d.ts +1172 -0
  55. package/dist/tsdoc-metadata.json +11 -0
  56. package/docs/.gitattributes +2 -0
  57. package/docs/api/foundation-entity-management.datasourceconfiguration.md +29 -0
  58. package/docs/api/foundation-entity-management.entitymanagement.closemodal.md +15 -0
  59. package/docs/api/foundation-entity-management.entitymanagement.columns.md +13 -0
  60. package/docs/api/foundation-entity-management.entitymanagement.connect.md +18 -0
  61. package/docs/api/foundation-entity-management.entitymanagement.createevent.md +13 -0
  62. package/docs/api/foundation-entity-management.entitymanagement.createformuischema.md +11 -0
  63. package/docs/api/foundation-entity-management.entitymanagement.datasourceconfig.md +18 -0
  64. package/docs/api/foundation-entity-management.entitymanagement.deepclone.md +17 -0
  65. package/docs/api/foundation-entity-management.entitymanagement.deleteevent.md +13 -0
  66. package/docs/api/foundation-entity-management.entitymanagement.editdialogtitle.md +13 -0
  67. package/docs/api/foundation-entity-management.entitymanagement.editedentity.md +13 -0
  68. package/docs/api/foundation-entity-management.entitymanagement.editentitymodal.md +11 -0
  69. package/docs/api/foundation-entity-management.entitymanagement.editmodalvisible.md +11 -0
  70. package/docs/api/foundation-entity-management.entitymanagement.editmodalvisiblechanged.md +15 -0
  71. package/docs/api/foundation-entity-management.entitymanagement.enablecellflashing.md +11 -0
  72. package/docs/api/foundation-entity-management.entitymanagement.enablefilterbar.md +11 -0
  73. package/docs/api/foundation-entity-management.entitymanagement.entitylabel.md +13 -0
  74. package/docs/api/foundation-entity-management.entitymanagement.errornotify.md +24 -0
  75. package/docs/api/foundation-entity-management.entitymanagement.formuischema.md +11 -0
  76. package/docs/api/foundation-entity-management.entitymanagement.md +74 -0
  77. package/docs/api/foundation-entity-management.entitymanagement.persistcolumnstatekey.md +18 -0
  78. package/docs/api/foundation-entity-management.entitymanagement.readevent.md +11 -0
  79. package/docs/api/foundation-entity-management.entitymanagement.readeventfn.md +11 -0
  80. package/docs/api/foundation-entity-management.entitymanagement.readonly.md +11 -0
  81. package/docs/api/foundation-entity-management.entitymanagement.resourcename.md +13 -0
  82. package/docs/api/foundation-entity-management.entitymanagement.selectedentity.md +18 -0
  83. package/docs/api/foundation-entity-management.entitymanagement.sizecolumnstofit.md +11 -0
  84. package/docs/api/foundation-entity-management.entitymanagement.submitentitychanges.md +24 -0
  85. package/docs/api/foundation-entity-management.entitymanagement.submitting.md +11 -0
  86. package/docs/api/foundation-entity-management.entitymanagement.title.md +13 -0
  87. package/docs/api/foundation-entity-management.entitymanagement.updateevent.md +13 -0
  88. package/docs/api/foundation-entity-management.entitymanagement.updateformuischema.md +11 -0
  89. package/docs/api/foundation-entity-management.geterrorformat.md +13 -0
  90. package/docs/api/foundation-entity-management.md +27 -0
  91. package/docs/api/foundation-entity-management.profiles._constructor_.md +13 -0
  92. package/docs/api/foundation-entity-management.profiles.deleteentity.md +22 -0
  93. package/docs/api/foundation-entity-management.profiles.md +40 -0
  94. package/docs/api/foundation-entity-management.profiles.readprofiledata.md +26 -0
  95. package/docs/api/foundation-entity-management.users._constructor_.md +13 -0
  96. package/docs/api/foundation-entity-management.users.additionalcreatefields.md +11 -0
  97. package/docs/api/foundation-entity-management.users.additionalupdatefields.md +11 -0
  98. package/docs/api/foundation-entity-management.users.allaccesstype.md +11 -0
  99. package/docs/api/foundation-entity-management.users.columns.md +13 -0
  100. package/docs/api/foundation-entity-management.users.connectedcallback.md +15 -0
  101. package/docs/api/foundation-entity-management.users.createevent.md +13 -0
  102. package/docs/api/foundation-entity-management.users.deepclone.md +15 -0
  103. package/docs/api/foundation-entity-management.users.deleteevent.md +13 -0
  104. package/docs/api/foundation-entity-management.users.md +69 -0
  105. package/docs/api/foundation-entity-management.users.updateevent.md +13 -0
  106. package/docs/api/foundation-entity-management.userscolumnconfig.md +35 -0
  107. package/docs/api/index.md +12 -0
  108. package/docs/api-report.md +200 -0
  109. package/docs/img/foundation-entity-management-form.png +0 -0
  110. package/docs/img/foundation-entity-management-grid.png +0 -0
  111. package/docs/img/foundation-profile-management.png +0 -0
  112. package/docs/img/foundation-user-management.png +0 -0
  113. package/license.txt +46 -0
  114. package/package.json +123 -0
@@ -0,0 +1,1727 @@
1
+ {
2
+ "metadata": {
3
+ "toolPackage": "@microsoft/api-extractor",
4
+ "toolVersion": "7.34.4",
5
+ "schemaVersion": 1011,
6
+ "oldestForwardsCompatibleVersion": 1001,
7
+ "tsdocConfig": {
8
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
+ "noStandardTags": true,
10
+ "tagDefinitions": [
11
+ {
12
+ "tagName": "@alpha",
13
+ "syntaxKind": "modifier"
14
+ },
15
+ {
16
+ "tagName": "@beta",
17
+ "syntaxKind": "modifier"
18
+ },
19
+ {
20
+ "tagName": "@defaultValue",
21
+ "syntaxKind": "block"
22
+ },
23
+ {
24
+ "tagName": "@decorator",
25
+ "syntaxKind": "block",
26
+ "allowMultiple": true
27
+ },
28
+ {
29
+ "tagName": "@deprecated",
30
+ "syntaxKind": "block"
31
+ },
32
+ {
33
+ "tagName": "@eventProperty",
34
+ "syntaxKind": "modifier"
35
+ },
36
+ {
37
+ "tagName": "@example",
38
+ "syntaxKind": "block",
39
+ "allowMultiple": true
40
+ },
41
+ {
42
+ "tagName": "@experimental",
43
+ "syntaxKind": "modifier"
44
+ },
45
+ {
46
+ "tagName": "@inheritDoc",
47
+ "syntaxKind": "inline"
48
+ },
49
+ {
50
+ "tagName": "@internal",
51
+ "syntaxKind": "modifier"
52
+ },
53
+ {
54
+ "tagName": "@label",
55
+ "syntaxKind": "inline"
56
+ },
57
+ {
58
+ "tagName": "@link",
59
+ "syntaxKind": "inline",
60
+ "allowMultiple": true
61
+ },
62
+ {
63
+ "tagName": "@override",
64
+ "syntaxKind": "modifier"
65
+ },
66
+ {
67
+ "tagName": "@packageDocumentation",
68
+ "syntaxKind": "modifier"
69
+ },
70
+ {
71
+ "tagName": "@param",
72
+ "syntaxKind": "block",
73
+ "allowMultiple": true
74
+ },
75
+ {
76
+ "tagName": "@privateRemarks",
77
+ "syntaxKind": "block"
78
+ },
79
+ {
80
+ "tagName": "@public",
81
+ "syntaxKind": "modifier"
82
+ },
83
+ {
84
+ "tagName": "@readonly",
85
+ "syntaxKind": "modifier"
86
+ },
87
+ {
88
+ "tagName": "@remarks",
89
+ "syntaxKind": "block"
90
+ },
91
+ {
92
+ "tagName": "@returns",
93
+ "syntaxKind": "block"
94
+ },
95
+ {
96
+ "tagName": "@sealed",
97
+ "syntaxKind": "modifier"
98
+ },
99
+ {
100
+ "tagName": "@see",
101
+ "syntaxKind": "block"
102
+ },
103
+ {
104
+ "tagName": "@throws",
105
+ "syntaxKind": "block",
106
+ "allowMultiple": true
107
+ },
108
+ {
109
+ "tagName": "@typeParam",
110
+ "syntaxKind": "block",
111
+ "allowMultiple": true
112
+ },
113
+ {
114
+ "tagName": "@virtual",
115
+ "syntaxKind": "modifier"
116
+ },
117
+ {
118
+ "tagName": "@betaDocumentation",
119
+ "syntaxKind": "modifier"
120
+ },
121
+ {
122
+ "tagName": "@internalRemarks",
123
+ "syntaxKind": "block"
124
+ },
125
+ {
126
+ "tagName": "@preapproved",
127
+ "syntaxKind": "modifier"
128
+ }
129
+ ],
130
+ "supportForTags": {
131
+ "@alpha": true,
132
+ "@beta": true,
133
+ "@defaultValue": true,
134
+ "@decorator": true,
135
+ "@deprecated": true,
136
+ "@eventProperty": true,
137
+ "@example": true,
138
+ "@experimental": true,
139
+ "@inheritDoc": true,
140
+ "@internal": true,
141
+ "@label": true,
142
+ "@link": true,
143
+ "@override": true,
144
+ "@packageDocumentation": true,
145
+ "@param": true,
146
+ "@privateRemarks": true,
147
+ "@public": true,
148
+ "@readonly": true,
149
+ "@remarks": true,
150
+ "@returns": true,
151
+ "@sealed": true,
152
+ "@see": true,
153
+ "@throws": true,
154
+ "@typeParam": true,
155
+ "@virtual": true,
156
+ "@betaDocumentation": true,
157
+ "@internalRemarks": true,
158
+ "@preapproved": true
159
+ },
160
+ "reportUnsupportedHtmlElements": false
161
+ }
162
+ },
163
+ "kind": "Package",
164
+ "canonicalReference": "@genesislcap/foundation-entity-management!",
165
+ "docComment": "",
166
+ "name": "@genesislcap/foundation-entity-management",
167
+ "preserveMemberOrder": false,
168
+ "members": [
169
+ {
170
+ "kind": "EntryPoint",
171
+ "canonicalReference": "@genesislcap/foundation-entity-management!",
172
+ "name": "",
173
+ "preserveMemberOrder": false,
174
+ "members": [
175
+ {
176
+ "kind": "TypeAlias",
177
+ "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type",
178
+ "docComment": "/**\n * The attribute which is set to configure the resource that the entity manager is working with\n *\n * @example\n * ```javascript\n * type DatasourceConfiguration = {\n * criteria?: string;\n * fields?: string;\n * isSnapshot?: boolean;\n * maxRows?: number;\n * maxView?: number;\n * orderBy?: string;\n * reverse?: boolean;\n * }\n * ```\n *\n * @public\n */\n",
179
+ "excerptTokens": [
180
+ {
181
+ "kind": "Content",
182
+ "text": "export type DatasourceConfiguration = "
183
+ },
184
+ {
185
+ "kind": "Reference",
186
+ "text": "Omit",
187
+ "canonicalReference": "!Omit:type"
188
+ },
189
+ {
190
+ "kind": "Content",
191
+ "text": "<"
192
+ },
193
+ {
194
+ "kind": "Reference",
195
+ "text": "DatasourceOptions",
196
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions:interface"
197
+ },
198
+ {
199
+ "kind": "Content",
200
+ "text": ", 'resourceName' | 'request'>"
201
+ },
202
+ {
203
+ "kind": "Content",
204
+ "text": ";"
205
+ }
206
+ ],
207
+ "fileUrlPath": "src/entities/entities.ts",
208
+ "releaseTag": "Public",
209
+ "name": "DatasourceConfiguration",
210
+ "typeTokenRange": {
211
+ "startIndex": 1,
212
+ "endIndex": 5
213
+ }
214
+ },
215
+ {
216
+ "kind": "Class",
217
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement:class",
218
+ "docComment": "/**\n * Main class which defines the entity management functionality\n *\n * @remarks\n *\n * Connects to a backend resource and wraps up a grid which is populated with entities from that resource. The different interactions that the user can perform with the entities can be configured, examples being able to update and delete entities.\n *\n * @example\n *\n * Example of using the entity management system to handle counterparties\n * ```\n * <entity-management\n * resourceName=\"ALL_COUNTERPARTYS\"\n * title=\"Counterparty Management\"\n * updateEvent=\"EVENT_COUNTERPARTY_MODIFY\"\n * deleteEvent=\"EVENT_COUNTERPARTY_DELETE\"\n * createEvent=\"EVENT_COUNTERPARTY_INSERT\"\n * ></entity-management>\n * ```\n *\n * Where:<br /> - the title of the grid is `Counterparty Management`<br /> - the name of the resource in the database to manage is `ALL_COUNTERPARTYS`<br /> - the name of the event handler for update events is `EVENT_COUNTERPARTY_MODIFY`<br /> - the name of the event handler for create events is `EVENT_COUNTERPARTY_INSERT`<br /> - the name of the event handler for delete events is `EVENT_COUNTERPARTY_DELETE`<br />\n *\n * @public\n */\n",
219
+ "excerptTokens": [
220
+ {
221
+ "kind": "Content",
222
+ "text": "export declare class EntityManagement extends "
223
+ },
224
+ {
225
+ "kind": "Reference",
226
+ "text": "EntityManagement_base",
227
+ "canonicalReference": "@genesislcap/foundation-entity-management!~EntityManagement_base"
228
+ },
229
+ {
230
+ "kind": "Content",
231
+ "text": " "
232
+ }
233
+ ],
234
+ "fileUrlPath": "src/entities/entities.ts",
235
+ "releaseTag": "Public",
236
+ "isAbstract": false,
237
+ "name": "EntityManagement",
238
+ "preserveMemberOrder": false,
239
+ "members": [
240
+ {
241
+ "kind": "Method",
242
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#closeModal:member(1)",
243
+ "docComment": "",
244
+ "excerptTokens": [
245
+ {
246
+ "kind": "Content",
247
+ "text": "closeModal(): "
248
+ },
249
+ {
250
+ "kind": "Content",
251
+ "text": "void"
252
+ },
253
+ {
254
+ "kind": "Content",
255
+ "text": ";"
256
+ }
257
+ ],
258
+ "isStatic": false,
259
+ "returnTypeTokenRange": {
260
+ "startIndex": 1,
261
+ "endIndex": 2
262
+ },
263
+ "releaseTag": "Public",
264
+ "isProtected": false,
265
+ "overloadIndex": 1,
266
+ "parameters": [],
267
+ "isOptional": false,
268
+ "isAbstract": false,
269
+ "name": "closeModal"
270
+ },
271
+ {
272
+ "kind": "Property",
273
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#columns:member",
274
+ "docComment": "/**\n * Array which holds the column definitions.\n *\n * @public\n */\n",
275
+ "excerptTokens": [
276
+ {
277
+ "kind": "Content",
278
+ "text": "columns: "
279
+ },
280
+ {
281
+ "kind": "Reference",
282
+ "text": "ColDef",
283
+ "canonicalReference": "@ag-grid-community/core!ColDef:interface"
284
+ },
285
+ {
286
+ "kind": "Content",
287
+ "text": "[]"
288
+ },
289
+ {
290
+ "kind": "Content",
291
+ "text": ";"
292
+ }
293
+ ],
294
+ "isReadonly": false,
295
+ "isOptional": false,
296
+ "releaseTag": "Public",
297
+ "name": "columns",
298
+ "propertyTypeTokenRange": {
299
+ "startIndex": 1,
300
+ "endIndex": 3
301
+ },
302
+ "isStatic": false,
303
+ "isProtected": false,
304
+ "isAbstract": false
305
+ },
306
+ {
307
+ "kind": "Property",
308
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#connect:member",
309
+ "docComment": "/**\n * DI connect object which is used to interact with the backend.\n *\n * @remarks\n *\n * Requires {@link @genesislcap/foundation-comms#Connect | the connect class} to be registered with the DI container\n */\n",
310
+ "excerptTokens": [
311
+ {
312
+ "kind": "Content",
313
+ "text": "protected connect: "
314
+ },
315
+ {
316
+ "kind": "Reference",
317
+ "text": "Connect",
318
+ "canonicalReference": "@genesislcap/foundation-comms!Connect:interface"
319
+ },
320
+ {
321
+ "kind": "Content",
322
+ "text": ";"
323
+ }
324
+ ],
325
+ "isReadonly": false,
326
+ "isOptional": false,
327
+ "releaseTag": "Public",
328
+ "name": "connect",
329
+ "propertyTypeTokenRange": {
330
+ "startIndex": 1,
331
+ "endIndex": 2
332
+ },
333
+ "isStatic": false,
334
+ "isProtected": true,
335
+ "isAbstract": false
336
+ },
337
+ {
338
+ "kind": "Property",
339
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createEvent:member",
340
+ "docComment": "/**\n * Name of the event handler on the Genesis server which handles creating an entity\n *\n * @public\n */\n",
341
+ "excerptTokens": [
342
+ {
343
+ "kind": "Content",
344
+ "text": "createEvent: "
345
+ },
346
+ {
347
+ "kind": "Content",
348
+ "text": "string"
349
+ },
350
+ {
351
+ "kind": "Content",
352
+ "text": ";"
353
+ }
354
+ ],
355
+ "isReadonly": false,
356
+ "isOptional": false,
357
+ "releaseTag": "Public",
358
+ "name": "createEvent",
359
+ "propertyTypeTokenRange": {
360
+ "startIndex": 1,
361
+ "endIndex": 2
362
+ },
363
+ "isStatic": false,
364
+ "isProtected": false,
365
+ "isAbstract": false
366
+ },
367
+ {
368
+ "kind": "Property",
369
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createFormUiSchema:member",
370
+ "docComment": "",
371
+ "excerptTokens": [
372
+ {
373
+ "kind": "Content",
374
+ "text": "createFormUiSchema: "
375
+ },
376
+ {
377
+ "kind": "Content",
378
+ "text": "any"
379
+ },
380
+ {
381
+ "kind": "Content",
382
+ "text": ";"
383
+ }
384
+ ],
385
+ "isReadonly": false,
386
+ "isOptional": false,
387
+ "releaseTag": "Public",
388
+ "name": "createFormUiSchema",
389
+ "propertyTypeTokenRange": {
390
+ "startIndex": 1,
391
+ "endIndex": 2
392
+ },
393
+ "isStatic": false,
394
+ "isProtected": false,
395
+ "isAbstract": false
396
+ },
397
+ {
398
+ "kind": "Property",
399
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#datasourceConfig:member",
400
+ "docComment": "/**\n * The configuration which is used when interacting with the resource on the backend\n *\n * @remarks\n *\n * Handles the configuration such as how many rows of entities to fetch at a time\n *\n * @public\n */\n",
401
+ "excerptTokens": [
402
+ {
403
+ "kind": "Content",
404
+ "text": "datasourceConfig: "
405
+ },
406
+ {
407
+ "kind": "Reference",
408
+ "text": "DatasourceConfiguration",
409
+ "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type"
410
+ },
411
+ {
412
+ "kind": "Content",
413
+ "text": ";"
414
+ }
415
+ ],
416
+ "isReadonly": false,
417
+ "isOptional": false,
418
+ "releaseTag": "Public",
419
+ "name": "datasourceConfig",
420
+ "propertyTypeTokenRange": {
421
+ "startIndex": 1,
422
+ "endIndex": 2
423
+ },
424
+ "isStatic": false,
425
+ "isProtected": false,
426
+ "isAbstract": false
427
+ },
428
+ {
429
+ "kind": "Method",
430
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deepClone:member(1)",
431
+ "docComment": "/**\n * Override the deepClone method to ensure that observable attributes are cloned\n *\n * @public\n */\n",
432
+ "excerptTokens": [
433
+ {
434
+ "kind": "Content",
435
+ "text": "deepClone(): "
436
+ },
437
+ {
438
+ "kind": "Reference",
439
+ "text": "Node",
440
+ "canonicalReference": "!Node:interface"
441
+ },
442
+ {
443
+ "kind": "Content",
444
+ "text": ";"
445
+ }
446
+ ],
447
+ "isStatic": false,
448
+ "returnTypeTokenRange": {
449
+ "startIndex": 1,
450
+ "endIndex": 2
451
+ },
452
+ "releaseTag": "Public",
453
+ "isProtected": false,
454
+ "overloadIndex": 1,
455
+ "parameters": [],
456
+ "isOptional": false,
457
+ "isAbstract": false,
458
+ "name": "deepClone"
459
+ },
460
+ {
461
+ "kind": "Property",
462
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deleteEvent:member",
463
+ "docComment": "/**\n * Name of the event handler on the Genesis server which handles deleting the entity\n *\n * @public\n */\n",
464
+ "excerptTokens": [
465
+ {
466
+ "kind": "Content",
467
+ "text": "deleteEvent: "
468
+ },
469
+ {
470
+ "kind": "Content",
471
+ "text": "string"
472
+ },
473
+ {
474
+ "kind": "Content",
475
+ "text": ";"
476
+ }
477
+ ],
478
+ "isReadonly": false,
479
+ "isOptional": false,
480
+ "releaseTag": "Public",
481
+ "name": "deleteEvent",
482
+ "propertyTypeTokenRange": {
483
+ "startIndex": 1,
484
+ "endIndex": 2
485
+ },
486
+ "isStatic": false,
487
+ "isProtected": false,
488
+ "isAbstract": false
489
+ },
490
+ {
491
+ "kind": "Property",
492
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editDialogTitle:member",
493
+ "docComment": "/**\n * String which contains the text of the popup modal when the user is adding or editing an entity\n */\n",
494
+ "excerptTokens": [
495
+ {
496
+ "kind": "Content",
497
+ "text": "editDialogTitle: "
498
+ },
499
+ {
500
+ "kind": "Content",
501
+ "text": "string"
502
+ },
503
+ {
504
+ "kind": "Content",
505
+ "text": ";"
506
+ }
507
+ ],
508
+ "isReadonly": false,
509
+ "isOptional": false,
510
+ "releaseTag": "Public",
511
+ "name": "editDialogTitle",
512
+ "propertyTypeTokenRange": {
513
+ "startIndex": 1,
514
+ "endIndex": 2
515
+ },
516
+ "isStatic": false,
517
+ "isProtected": false,
518
+ "isAbstract": false
519
+ },
520
+ {
521
+ "kind": "Property",
522
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editedEntity:member",
523
+ "docComment": "/**\n * Disables the form while enabled to stop the user dispatching a large number of duplicate events\n *\n * @public\n */\n",
524
+ "excerptTokens": [
525
+ {
526
+ "kind": "Content",
527
+ "text": "editedEntity: "
528
+ },
529
+ {
530
+ "kind": "Content",
531
+ "text": "any"
532
+ },
533
+ {
534
+ "kind": "Content",
535
+ "text": ";"
536
+ }
537
+ ],
538
+ "isReadonly": false,
539
+ "isOptional": false,
540
+ "releaseTag": "Public",
541
+ "name": "editedEntity",
542
+ "propertyTypeTokenRange": {
543
+ "startIndex": 1,
544
+ "endIndex": 2
545
+ },
546
+ "isStatic": false,
547
+ "isProtected": false,
548
+ "isAbstract": false
549
+ },
550
+ {
551
+ "kind": "Property",
552
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editEntityModal:member",
553
+ "docComment": "",
554
+ "excerptTokens": [
555
+ {
556
+ "kind": "Content",
557
+ "text": "editEntityModal: "
558
+ },
559
+ {
560
+ "kind": "Content",
561
+ "text": "any"
562
+ },
563
+ {
564
+ "kind": "Content",
565
+ "text": ";"
566
+ }
567
+ ],
568
+ "isReadonly": false,
569
+ "isOptional": false,
570
+ "releaseTag": "Public",
571
+ "name": "editEntityModal",
572
+ "propertyTypeTokenRange": {
573
+ "startIndex": 1,
574
+ "endIndex": 2
575
+ },
576
+ "isStatic": false,
577
+ "isProtected": false,
578
+ "isAbstract": false
579
+ },
580
+ {
581
+ "kind": "Property",
582
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editModalVisible:member",
583
+ "docComment": "",
584
+ "excerptTokens": [
585
+ {
586
+ "kind": "Content",
587
+ "text": "editModalVisible: "
588
+ },
589
+ {
590
+ "kind": "Content",
591
+ "text": "boolean"
592
+ },
593
+ {
594
+ "kind": "Content",
595
+ "text": ";"
596
+ }
597
+ ],
598
+ "isReadonly": false,
599
+ "isOptional": false,
600
+ "releaseTag": "Public",
601
+ "name": "editModalVisible",
602
+ "propertyTypeTokenRange": {
603
+ "startIndex": 1,
604
+ "endIndex": 2
605
+ },
606
+ "isStatic": false,
607
+ "isProtected": false,
608
+ "isAbstract": false
609
+ },
610
+ {
611
+ "kind": "Method",
612
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#editModalVisibleChanged:member(1)",
613
+ "docComment": "",
614
+ "excerptTokens": [
615
+ {
616
+ "kind": "Content",
617
+ "text": "editModalVisibleChanged(): "
618
+ },
619
+ {
620
+ "kind": "Content",
621
+ "text": "void"
622
+ },
623
+ {
624
+ "kind": "Content",
625
+ "text": ";"
626
+ }
627
+ ],
628
+ "isStatic": false,
629
+ "returnTypeTokenRange": {
630
+ "startIndex": 1,
631
+ "endIndex": 2
632
+ },
633
+ "releaseTag": "Public",
634
+ "isProtected": false,
635
+ "overloadIndex": 1,
636
+ "parameters": [],
637
+ "isOptional": false,
638
+ "isAbstract": false,
639
+ "name": "editModalVisibleChanged"
640
+ },
641
+ {
642
+ "kind": "Property",
643
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableCellFlashing:member",
644
+ "docComment": "",
645
+ "excerptTokens": [
646
+ {
647
+ "kind": "Content",
648
+ "text": "enableCellFlashing: "
649
+ },
650
+ {
651
+ "kind": "Content",
652
+ "text": "boolean"
653
+ },
654
+ {
655
+ "kind": "Content",
656
+ "text": ";"
657
+ }
658
+ ],
659
+ "isReadonly": false,
660
+ "isOptional": false,
661
+ "releaseTag": "Public",
662
+ "name": "enableCellFlashing",
663
+ "propertyTypeTokenRange": {
664
+ "startIndex": 1,
665
+ "endIndex": 2
666
+ },
667
+ "isStatic": false,
668
+ "isProtected": false,
669
+ "isAbstract": false
670
+ },
671
+ {
672
+ "kind": "Property",
673
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableFilterBar:member",
674
+ "docComment": "",
675
+ "excerptTokens": [
676
+ {
677
+ "kind": "Content",
678
+ "text": "enableFilterBar: "
679
+ },
680
+ {
681
+ "kind": "Content",
682
+ "text": "boolean"
683
+ },
684
+ {
685
+ "kind": "Content",
686
+ "text": ";"
687
+ }
688
+ ],
689
+ "isReadonly": false,
690
+ "isOptional": false,
691
+ "releaseTag": "Public",
692
+ "name": "enableFilterBar",
693
+ "propertyTypeTokenRange": {
694
+ "startIndex": 1,
695
+ "endIndex": 2
696
+ },
697
+ "isStatic": false,
698
+ "isProtected": false,
699
+ "isAbstract": false
700
+ },
701
+ {
702
+ "kind": "Property",
703
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#entityLabel:member",
704
+ "docComment": "/**\n * Label for the entity which has usages such as being shown in the title of the modal wen editing the entity\n *\n * @public\n */\n",
705
+ "excerptTokens": [
706
+ {
707
+ "kind": "Content",
708
+ "text": "entityLabel: "
709
+ },
710
+ {
711
+ "kind": "Content",
712
+ "text": "string"
713
+ },
714
+ {
715
+ "kind": "Content",
716
+ "text": ";"
717
+ }
718
+ ],
719
+ "isReadonly": false,
720
+ "isOptional": false,
721
+ "releaseTag": "Public",
722
+ "name": "entityLabel",
723
+ "propertyTypeTokenRange": {
724
+ "startIndex": 1,
725
+ "endIndex": 2
726
+ },
727
+ "isStatic": false,
728
+ "isProtected": false,
729
+ "isAbstract": false
730
+ },
731
+ {
732
+ "kind": "Method",
733
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#errorNotify:member(1)",
734
+ "docComment": "/**\n * Show notifications if the executed event returned an error.\n *\n * @public\n */\n",
735
+ "excerptTokens": [
736
+ {
737
+ "kind": "Content",
738
+ "text": "errorNotify(request: "
739
+ },
740
+ {
741
+ "kind": "Content",
742
+ "text": "any"
743
+ },
744
+ {
745
+ "kind": "Content",
746
+ "text": "): "
747
+ },
748
+ {
749
+ "kind": "Content",
750
+ "text": "void"
751
+ },
752
+ {
753
+ "kind": "Content",
754
+ "text": ";"
755
+ }
756
+ ],
757
+ "isStatic": false,
758
+ "returnTypeTokenRange": {
759
+ "startIndex": 3,
760
+ "endIndex": 4
761
+ },
762
+ "releaseTag": "Public",
763
+ "isProtected": false,
764
+ "overloadIndex": 1,
765
+ "parameters": [
766
+ {
767
+ "parameterName": "request",
768
+ "parameterTypeTokenRange": {
769
+ "startIndex": 1,
770
+ "endIndex": 2
771
+ },
772
+ "isOptional": false
773
+ }
774
+ ],
775
+ "isOptional": false,
776
+ "isAbstract": false,
777
+ "name": "errorNotify"
778
+ },
779
+ {
780
+ "kind": "Property",
781
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#formUiSchema:member",
782
+ "docComment": "",
783
+ "excerptTokens": [
784
+ {
785
+ "kind": "Content",
786
+ "text": "formUiSchema: "
787
+ },
788
+ {
789
+ "kind": "Content",
790
+ "text": "any"
791
+ },
792
+ {
793
+ "kind": "Content",
794
+ "text": ";"
795
+ }
796
+ ],
797
+ "isReadonly": false,
798
+ "isOptional": false,
799
+ "releaseTag": "Public",
800
+ "name": "formUiSchema",
801
+ "propertyTypeTokenRange": {
802
+ "startIndex": 1,
803
+ "endIndex": 2
804
+ },
805
+ "isStatic": false,
806
+ "isProtected": false,
807
+ "isAbstract": false
808
+ },
809
+ {
810
+ "kind": "Property",
811
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#persistColumnStateKey:member",
812
+ "docComment": "/**\n * 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.\n *\n * @remarks\n *\n * Setting this value will set the entity manager to persist the column states through page refreshes etc. An example of what is stored is when the user resizes or reorders columns. This value must be unique for each table in your app otherwise the persisted data will be corrupted. There is an option on the grid for the user to reset the table to the default layout if they wish. If you omit this attribute then nothing is persisted\n *\n * @public\n */\n",
813
+ "excerptTokens": [
814
+ {
815
+ "kind": "Content",
816
+ "text": "persistColumnStateKey: "
817
+ },
818
+ {
819
+ "kind": "Content",
820
+ "text": "string"
821
+ },
822
+ {
823
+ "kind": "Content",
824
+ "text": ";"
825
+ }
826
+ ],
827
+ "isReadonly": false,
828
+ "isOptional": false,
829
+ "releaseTag": "Public",
830
+ "name": "persistColumnStateKey",
831
+ "propertyTypeTokenRange": {
832
+ "startIndex": 1,
833
+ "endIndex": 2
834
+ },
835
+ "isStatic": false,
836
+ "isProtected": false,
837
+ "isAbstract": false
838
+ },
839
+ {
840
+ "kind": "Property",
841
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#readEvent:member",
842
+ "docComment": "",
843
+ "excerptTokens": [
844
+ {
845
+ "kind": "Content",
846
+ "text": "readEvent: "
847
+ },
848
+ {
849
+ "kind": "Content",
850
+ "text": "string"
851
+ },
852
+ {
853
+ "kind": "Content",
854
+ "text": ";"
855
+ }
856
+ ],
857
+ "isReadonly": false,
858
+ "isOptional": false,
859
+ "releaseTag": "Public",
860
+ "name": "readEvent",
861
+ "propertyTypeTokenRange": {
862
+ "startIndex": 1,
863
+ "endIndex": 2
864
+ },
865
+ "isStatic": false,
866
+ "isProtected": false,
867
+ "isAbstract": false
868
+ },
869
+ {
870
+ "kind": "Property",
871
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#readEventFn:member",
872
+ "docComment": "",
873
+ "excerptTokens": [
874
+ {
875
+ "kind": "Content",
876
+ "text": "readEventFn: "
877
+ },
878
+ {
879
+ "kind": "Content",
880
+ "text": "(...args: any[]) => {}"
881
+ },
882
+ {
883
+ "kind": "Content",
884
+ "text": ";"
885
+ }
886
+ ],
887
+ "isReadonly": false,
888
+ "isOptional": false,
889
+ "releaseTag": "Public",
890
+ "name": "readEventFn",
891
+ "propertyTypeTokenRange": {
892
+ "startIndex": 1,
893
+ "endIndex": 2
894
+ },
895
+ "isStatic": false,
896
+ "isProtected": false,
897
+ "isAbstract": false
898
+ },
899
+ {
900
+ "kind": "Property",
901
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#readonly:member",
902
+ "docComment": "",
903
+ "excerptTokens": [
904
+ {
905
+ "kind": "Content",
906
+ "text": "readonly: "
907
+ },
908
+ {
909
+ "kind": "Content",
910
+ "text": "boolean"
911
+ },
912
+ {
913
+ "kind": "Content",
914
+ "text": ";"
915
+ }
916
+ ],
917
+ "isReadonly": false,
918
+ "isOptional": false,
919
+ "releaseTag": "Public",
920
+ "name": "readonly",
921
+ "propertyTypeTokenRange": {
922
+ "startIndex": 1,
923
+ "endIndex": 2
924
+ },
925
+ "isStatic": false,
926
+ "isProtected": false,
927
+ "isAbstract": false
928
+ },
929
+ {
930
+ "kind": "Property",
931
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#resourceName:member",
932
+ "docComment": "/**\n * Name of the backend resource which contain the entities to manage\n *\n * @public\n */\n",
933
+ "excerptTokens": [
934
+ {
935
+ "kind": "Content",
936
+ "text": "resourceName: "
937
+ },
938
+ {
939
+ "kind": "Content",
940
+ "text": "string"
941
+ },
942
+ {
943
+ "kind": "Content",
944
+ "text": ";"
945
+ }
946
+ ],
947
+ "isReadonly": false,
948
+ "isOptional": false,
949
+ "releaseTag": "Public",
950
+ "name": "resourceName",
951
+ "propertyTypeTokenRange": {
952
+ "startIndex": 1,
953
+ "endIndex": 2
954
+ },
955
+ "isStatic": false,
956
+ "isProtected": false,
957
+ "isAbstract": false
958
+ },
959
+ {
960
+ "kind": "Property",
961
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#selectedEntity:member",
962
+ "docComment": "/**\n * Reference to the currently selected entity from the grid.\n *\n * @remarks\n *\n * When the user attempts to initiate functionality such as deleting or editing an entity, the entity which will be deleted/edited is the one which is referenced by this variable\n *\n * @public\n */\n",
963
+ "excerptTokens": [
964
+ {
965
+ "kind": "Content",
966
+ "text": "selectedEntity: "
967
+ },
968
+ {
969
+ "kind": "Content",
970
+ "text": "any"
971
+ },
972
+ {
973
+ "kind": "Content",
974
+ "text": ";"
975
+ }
976
+ ],
977
+ "isReadonly": false,
978
+ "isOptional": false,
979
+ "releaseTag": "Public",
980
+ "name": "selectedEntity",
981
+ "propertyTypeTokenRange": {
982
+ "startIndex": 1,
983
+ "endIndex": 2
984
+ },
985
+ "isStatic": false,
986
+ "isProtected": false,
987
+ "isAbstract": false
988
+ },
989
+ {
990
+ "kind": "Property",
991
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#sizeColumnsToFit:member",
992
+ "docComment": "",
993
+ "excerptTokens": [
994
+ {
995
+ "kind": "Content",
996
+ "text": "sizeColumnsToFit: "
997
+ },
998
+ {
999
+ "kind": "Content",
1000
+ "text": "boolean"
1001
+ },
1002
+ {
1003
+ "kind": "Content",
1004
+ "text": ";"
1005
+ }
1006
+ ],
1007
+ "isReadonly": false,
1008
+ "isOptional": false,
1009
+ "releaseTag": "Public",
1010
+ "name": "sizeColumnsToFit",
1011
+ "propertyTypeTokenRange": {
1012
+ "startIndex": 1,
1013
+ "endIndex": 2
1014
+ },
1015
+ "isStatic": false,
1016
+ "isProtected": false,
1017
+ "isAbstract": false
1018
+ },
1019
+ {
1020
+ "kind": "Method",
1021
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#submitEntityChanges:member(1)",
1022
+ "docComment": "/**\n * Event handler for when the user submits the action for the currently open form, either editing or adding the entity\n *\n * @param e - CustomEvent which contains the payload for the entity to submit to the backend\n *\n * Emits an event upon error\n *\n * @public\n */\n",
1023
+ "excerptTokens": [
1024
+ {
1025
+ "kind": "Content",
1026
+ "text": "submitEntityChanges(e: "
1027
+ },
1028
+ {
1029
+ "kind": "Reference",
1030
+ "text": "CustomEvent",
1031
+ "canonicalReference": "!CustomEvent:interface"
1032
+ },
1033
+ {
1034
+ "kind": "Content",
1035
+ "text": "): "
1036
+ },
1037
+ {
1038
+ "kind": "Reference",
1039
+ "text": "Promise",
1040
+ "canonicalReference": "!Promise:interface"
1041
+ },
1042
+ {
1043
+ "kind": "Content",
1044
+ "text": "<void>"
1045
+ },
1046
+ {
1047
+ "kind": "Content",
1048
+ "text": ";"
1049
+ }
1050
+ ],
1051
+ "isStatic": false,
1052
+ "returnTypeTokenRange": {
1053
+ "startIndex": 3,
1054
+ "endIndex": 5
1055
+ },
1056
+ "releaseTag": "Public",
1057
+ "isProtected": false,
1058
+ "overloadIndex": 1,
1059
+ "parameters": [
1060
+ {
1061
+ "parameterName": "e",
1062
+ "parameterTypeTokenRange": {
1063
+ "startIndex": 1,
1064
+ "endIndex": 2
1065
+ },
1066
+ "isOptional": false
1067
+ }
1068
+ ],
1069
+ "isOptional": false,
1070
+ "isAbstract": false,
1071
+ "name": "submitEntityChanges"
1072
+ },
1073
+ {
1074
+ "kind": "Property",
1075
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#submitting:member",
1076
+ "docComment": "",
1077
+ "excerptTokens": [
1078
+ {
1079
+ "kind": "Content",
1080
+ "text": "submitting: "
1081
+ },
1082
+ {
1083
+ "kind": "Content",
1084
+ "text": "boolean"
1085
+ },
1086
+ {
1087
+ "kind": "Content",
1088
+ "text": ";"
1089
+ }
1090
+ ],
1091
+ "isReadonly": false,
1092
+ "isOptional": false,
1093
+ "releaseTag": "Public",
1094
+ "name": "submitting",
1095
+ "propertyTypeTokenRange": {
1096
+ "startIndex": 1,
1097
+ "endIndex": 2
1098
+ },
1099
+ "isStatic": false,
1100
+ "isProtected": false,
1101
+ "isAbstract": false
1102
+ },
1103
+ {
1104
+ "kind": "Property",
1105
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#title:member",
1106
+ "docComment": "/**\n * Title of the grid\n *\n * @public\n */\n",
1107
+ "excerptTokens": [
1108
+ {
1109
+ "kind": "Content",
1110
+ "text": "title: "
1111
+ },
1112
+ {
1113
+ "kind": "Content",
1114
+ "text": "string"
1115
+ },
1116
+ {
1117
+ "kind": "Content",
1118
+ "text": ";"
1119
+ }
1120
+ ],
1121
+ "isReadonly": false,
1122
+ "isOptional": false,
1123
+ "releaseTag": "Public",
1124
+ "name": "title",
1125
+ "propertyTypeTokenRange": {
1126
+ "startIndex": 1,
1127
+ "endIndex": 2
1128
+ },
1129
+ "isStatic": false,
1130
+ "isProtected": false,
1131
+ "isAbstract": false
1132
+ },
1133
+ {
1134
+ "kind": "Property",
1135
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#updateEvent:member",
1136
+ "docComment": "/**\n * Name of the event handler on the Genesis server which handles updating the entity\n *\n * @public\n */\n",
1137
+ "excerptTokens": [
1138
+ {
1139
+ "kind": "Content",
1140
+ "text": "updateEvent: "
1141
+ },
1142
+ {
1143
+ "kind": "Content",
1144
+ "text": "string"
1145
+ },
1146
+ {
1147
+ "kind": "Content",
1148
+ "text": ";"
1149
+ }
1150
+ ],
1151
+ "isReadonly": false,
1152
+ "isOptional": false,
1153
+ "releaseTag": "Public",
1154
+ "name": "updateEvent",
1155
+ "propertyTypeTokenRange": {
1156
+ "startIndex": 1,
1157
+ "endIndex": 2
1158
+ },
1159
+ "isStatic": false,
1160
+ "isProtected": false,
1161
+ "isAbstract": false
1162
+ },
1163
+ {
1164
+ "kind": "Property",
1165
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#updateFormUiSchema:member",
1166
+ "docComment": "",
1167
+ "excerptTokens": [
1168
+ {
1169
+ "kind": "Content",
1170
+ "text": "updateFormUiSchema: "
1171
+ },
1172
+ {
1173
+ "kind": "Content",
1174
+ "text": "any"
1175
+ },
1176
+ {
1177
+ "kind": "Content",
1178
+ "text": ";"
1179
+ }
1180
+ ],
1181
+ "isReadonly": false,
1182
+ "isOptional": false,
1183
+ "releaseTag": "Public",
1184
+ "name": "updateFormUiSchema",
1185
+ "propertyTypeTokenRange": {
1186
+ "startIndex": 1,
1187
+ "endIndex": 2
1188
+ },
1189
+ "isStatic": false,
1190
+ "isProtected": false,
1191
+ "isAbstract": false
1192
+ }
1193
+ ],
1194
+ "extendsTokenRange": {
1195
+ "startIndex": 1,
1196
+ "endIndex": 2
1197
+ },
1198
+ "implementsTokenRanges": []
1199
+ },
1200
+ {
1201
+ "kind": "Variable",
1202
+ "canonicalReference": "@genesislcap/foundation-entity-management!getErrorFormat:var",
1203
+ "docComment": "/**\n * Format the error as a string with a different format depending on whether `err` has a `FIELD` property or not\n *\n * @public\n */\n",
1204
+ "excerptTokens": [
1205
+ {
1206
+ "kind": "Content",
1207
+ "text": "getErrorFormat: "
1208
+ },
1209
+ {
1210
+ "kind": "Content",
1211
+ "text": "(err: any) => string"
1212
+ }
1213
+ ],
1214
+ "fileUrlPath": "src/utils/formatting.ts",
1215
+ "isReadonly": true,
1216
+ "releaseTag": "Public",
1217
+ "name": "getErrorFormat",
1218
+ "variableTypeTokenRange": {
1219
+ "startIndex": 1,
1220
+ "endIndex": 2
1221
+ }
1222
+ },
1223
+ {
1224
+ "kind": "Class",
1225
+ "canonicalReference": "@genesislcap/foundation-entity-management!Profiles:class",
1226
+ "docComment": "/**\n * Main class which defined the profile management functionality\n *\n * @remarks\n *\n * Under the hood the profile-management is the entity-management micro-frontend configured for use with the `ALL_PROFILES` resource.\n *\n * @example\n *\n * You can use this class by forward declaring it in the template file where it is used, and then using it in a html template. It is recommended to wrap it in an error boundary.\n * ```javascript\n * <profile-management></profile-management>\n * ```\n *\n * @public\n */\n",
1227
+ "excerptTokens": [
1228
+ {
1229
+ "kind": "Content",
1230
+ "text": "export declare class Profiles extends "
1231
+ },
1232
+ {
1233
+ "kind": "Reference",
1234
+ "text": "EntityManagement",
1235
+ "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement:class"
1236
+ },
1237
+ {
1238
+ "kind": "Content",
1239
+ "text": " "
1240
+ }
1241
+ ],
1242
+ "fileUrlPath": "src/profiles/profiles.ts",
1243
+ "releaseTag": "Public",
1244
+ "isAbstract": false,
1245
+ "name": "Profiles",
1246
+ "preserveMemberOrder": false,
1247
+ "members": [
1248
+ {
1249
+ "kind": "Constructor",
1250
+ "canonicalReference": "@genesislcap/foundation-entity-management!Profiles:constructor(1)",
1251
+ "docComment": "/**\n * Constructor will set the {@link EntityManagement.createEvent} {@link EntityManagement.deleteEvent} {@link EntityManagement.updateEvent} to match the permissions set from the server\n */\n",
1252
+ "excerptTokens": [
1253
+ {
1254
+ "kind": "Content",
1255
+ "text": "constructor();"
1256
+ }
1257
+ ],
1258
+ "releaseTag": "Public",
1259
+ "isProtected": false,
1260
+ "overloadIndex": 1,
1261
+ "parameters": []
1262
+ },
1263
+ {
1264
+ "kind": "Method",
1265
+ "canonicalReference": "@genesislcap/foundation-entity-management!Profiles#deleteEntity:member(1)",
1266
+ "docComment": "",
1267
+ "excerptTokens": [
1268
+ {
1269
+ "kind": "Content",
1270
+ "text": "deleteEntity(e: "
1271
+ },
1272
+ {
1273
+ "kind": "Content",
1274
+ "text": "any"
1275
+ },
1276
+ {
1277
+ "kind": "Content",
1278
+ "text": "): "
1279
+ },
1280
+ {
1281
+ "kind": "Reference",
1282
+ "text": "Promise",
1283
+ "canonicalReference": "!Promise:interface"
1284
+ },
1285
+ {
1286
+ "kind": "Content",
1287
+ "text": "<void>"
1288
+ },
1289
+ {
1290
+ "kind": "Content",
1291
+ "text": ";"
1292
+ }
1293
+ ],
1294
+ "isStatic": false,
1295
+ "returnTypeTokenRange": {
1296
+ "startIndex": 3,
1297
+ "endIndex": 5
1298
+ },
1299
+ "releaseTag": "Public",
1300
+ "isProtected": false,
1301
+ "overloadIndex": 1,
1302
+ "parameters": [
1303
+ {
1304
+ "parameterName": "e",
1305
+ "parameterTypeTokenRange": {
1306
+ "startIndex": 1,
1307
+ "endIndex": 2
1308
+ },
1309
+ "isOptional": false
1310
+ }
1311
+ ],
1312
+ "isOptional": false,
1313
+ "isAbstract": false,
1314
+ "name": "deleteEntity"
1315
+ },
1316
+ {
1317
+ "kind": "Method",
1318
+ "canonicalReference": "@genesislcap/foundation-entity-management!Profiles#readProfileData:member(1)",
1319
+ "docComment": "",
1320
+ "excerptTokens": [
1321
+ {
1322
+ "kind": "Content",
1323
+ "text": "readProfileData(profile: "
1324
+ },
1325
+ {
1326
+ "kind": "Content",
1327
+ "text": "any"
1328
+ },
1329
+ {
1330
+ "kind": "Content",
1331
+ "text": "): "
1332
+ },
1333
+ {
1334
+ "kind": "Reference",
1335
+ "text": "Promise",
1336
+ "canonicalReference": "!Promise:interface"
1337
+ },
1338
+ {
1339
+ "kind": "Content",
1340
+ "text": "<{\n RIGHT_CODES: any[];\n USER_NAMES: any[];\n NAME: any;\n }>"
1341
+ },
1342
+ {
1343
+ "kind": "Content",
1344
+ "text": ";"
1345
+ }
1346
+ ],
1347
+ "isStatic": false,
1348
+ "returnTypeTokenRange": {
1349
+ "startIndex": 3,
1350
+ "endIndex": 5
1351
+ },
1352
+ "releaseTag": "Public",
1353
+ "isProtected": false,
1354
+ "overloadIndex": 1,
1355
+ "parameters": [
1356
+ {
1357
+ "parameterName": "profile",
1358
+ "parameterTypeTokenRange": {
1359
+ "startIndex": 1,
1360
+ "endIndex": 2
1361
+ },
1362
+ "isOptional": false
1363
+ }
1364
+ ],
1365
+ "isOptional": false,
1366
+ "isAbstract": false,
1367
+ "name": "readProfileData"
1368
+ }
1369
+ ],
1370
+ "extendsTokenRange": {
1371
+ "startIndex": 1,
1372
+ "endIndex": 2
1373
+ },
1374
+ "implementsTokenRanges": []
1375
+ },
1376
+ {
1377
+ "kind": "Class",
1378
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users:class",
1379
+ "docComment": "/**\n * Main class which defines the user management functionality\n *\n * @remarks\n *\n * Under the hood the user-management is the entity-management micro-frontend configured for use with the `ALL_USERS` resource.\n *\n * @example\n *\n * With no customisation required the user management micro-frontend can simply be dropped into the template as shown. However, it is advised to wrap it in an error boundary component.\n * ```javascript\n * <user-management></user-management>\n * ```\n *\n * With this default example above the columns will be the {@link UsersColumnConfig} as well as the entity and status columns. The entity and status columns are always added regardless of the other columns which are configured.\n *\n * You can add in additional customisation options. For example you can define a custom column and then mix-in with the standard columns\n * ```javascript\n * import { Users, UsersColumnConfig, } from '@genesislcap/foundation-entity-management';\n *\n * const userColumns = [\n * {\n * field: 'ACCESS_TYPE',\n * headerName: 'Access Type',\n * },\n * ];\n *\n * // Definition inside of the html template\n * <user-management :columns=${() => [...UsersColumnConfig, ...userColumns]}></user-management>\n * ```\n *\n * @public\n */\n",
1380
+ "excerptTokens": [
1381
+ {
1382
+ "kind": "Content",
1383
+ "text": "export declare class Users extends "
1384
+ },
1385
+ {
1386
+ "kind": "Reference",
1387
+ "text": "Users_base",
1388
+ "canonicalReference": "@genesislcap/foundation-entity-management!~Users_base"
1389
+ },
1390
+ {
1391
+ "kind": "Content",
1392
+ "text": " "
1393
+ }
1394
+ ],
1395
+ "fileUrlPath": "src/users/users.ts",
1396
+ "releaseTag": "Public",
1397
+ "isAbstract": false,
1398
+ "name": "Users",
1399
+ "preserveMemberOrder": false,
1400
+ "members": [
1401
+ {
1402
+ "kind": "Constructor",
1403
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users:constructor(1)",
1404
+ "docComment": "/**\n * Constructor will set the {@link Users.createEvent} {@link Users.deleteEvent} {@link Users.updateEvent} to match the permissions set from the server\n */\n",
1405
+ "excerptTokens": [
1406
+ {
1407
+ "kind": "Content",
1408
+ "text": "constructor();"
1409
+ }
1410
+ ],
1411
+ "releaseTag": "Public",
1412
+ "isProtected": false,
1413
+ "overloadIndex": 1,
1414
+ "parameters": []
1415
+ },
1416
+ {
1417
+ "kind": "Property",
1418
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#additionalCreateFields:member",
1419
+ "docComment": "",
1420
+ "excerptTokens": [
1421
+ {
1422
+ "kind": "Content",
1423
+ "text": "additionalCreateFields: "
1424
+ },
1425
+ {
1426
+ "kind": "Content",
1427
+ "text": "any"
1428
+ },
1429
+ {
1430
+ "kind": "Content",
1431
+ "text": ";"
1432
+ }
1433
+ ],
1434
+ "isReadonly": false,
1435
+ "isOptional": false,
1436
+ "releaseTag": "Public",
1437
+ "name": "additionalCreateFields",
1438
+ "propertyTypeTokenRange": {
1439
+ "startIndex": 1,
1440
+ "endIndex": 2
1441
+ },
1442
+ "isStatic": false,
1443
+ "isProtected": false,
1444
+ "isAbstract": false
1445
+ },
1446
+ {
1447
+ "kind": "Property",
1448
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#additionalUpdateFields:member",
1449
+ "docComment": "",
1450
+ "excerptTokens": [
1451
+ {
1452
+ "kind": "Content",
1453
+ "text": "additionalUpdateFields: "
1454
+ },
1455
+ {
1456
+ "kind": "Content",
1457
+ "text": "any"
1458
+ },
1459
+ {
1460
+ "kind": "Content",
1461
+ "text": ";"
1462
+ }
1463
+ ],
1464
+ "isReadonly": false,
1465
+ "isOptional": false,
1466
+ "releaseTag": "Public",
1467
+ "name": "additionalUpdateFields",
1468
+ "propertyTypeTokenRange": {
1469
+ "startIndex": 1,
1470
+ "endIndex": 2
1471
+ },
1472
+ "isStatic": false,
1473
+ "isProtected": false,
1474
+ "isAbstract": false
1475
+ },
1476
+ {
1477
+ "kind": "Property",
1478
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#allAccessType:member",
1479
+ "docComment": "",
1480
+ "excerptTokens": [
1481
+ {
1482
+ "kind": "Content",
1483
+ "text": "allAccessType: "
1484
+ },
1485
+ {
1486
+ "kind": "Content",
1487
+ "text": "boolean"
1488
+ },
1489
+ {
1490
+ "kind": "Content",
1491
+ "text": ";"
1492
+ }
1493
+ ],
1494
+ "isReadonly": false,
1495
+ "isOptional": false,
1496
+ "releaseTag": "Public",
1497
+ "name": "allAccessType",
1498
+ "propertyTypeTokenRange": {
1499
+ "startIndex": 1,
1500
+ "endIndex": 2
1501
+ },
1502
+ "isStatic": false,
1503
+ "isProtected": false,
1504
+ "isAbstract": false
1505
+ },
1506
+ {
1507
+ "kind": "Property",
1508
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#columns:member",
1509
+ "docComment": "/**\n * Column definition, default to the UsersColumnConfig\n */\n",
1510
+ "excerptTokens": [
1511
+ {
1512
+ "kind": "Content",
1513
+ "text": "columns: "
1514
+ },
1515
+ {
1516
+ "kind": "Content",
1517
+ "text": "any"
1518
+ },
1519
+ {
1520
+ "kind": "Content",
1521
+ "text": ";"
1522
+ }
1523
+ ],
1524
+ "isReadonly": false,
1525
+ "isOptional": false,
1526
+ "releaseTag": "Public",
1527
+ "name": "columns",
1528
+ "propertyTypeTokenRange": {
1529
+ "startIndex": 1,
1530
+ "endIndex": 2
1531
+ },
1532
+ "isStatic": false,
1533
+ "isProtected": false,
1534
+ "isAbstract": false
1535
+ },
1536
+ {
1537
+ "kind": "Method",
1538
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#connectedCallback:member(1)",
1539
+ "docComment": "",
1540
+ "excerptTokens": [
1541
+ {
1542
+ "kind": "Content",
1543
+ "text": "connectedCallback(): "
1544
+ },
1545
+ {
1546
+ "kind": "Reference",
1547
+ "text": "Promise",
1548
+ "canonicalReference": "!Promise:interface"
1549
+ },
1550
+ {
1551
+ "kind": "Content",
1552
+ "text": "<void>"
1553
+ },
1554
+ {
1555
+ "kind": "Content",
1556
+ "text": ";"
1557
+ }
1558
+ ],
1559
+ "isStatic": false,
1560
+ "returnTypeTokenRange": {
1561
+ "startIndex": 1,
1562
+ "endIndex": 3
1563
+ },
1564
+ "releaseTag": "Public",
1565
+ "isProtected": false,
1566
+ "overloadIndex": 1,
1567
+ "parameters": [],
1568
+ "isOptional": false,
1569
+ "isAbstract": false,
1570
+ "name": "connectedCallback"
1571
+ },
1572
+ {
1573
+ "kind": "Property",
1574
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#createEvent:member",
1575
+ "docComment": "/**\n * String which contains event if we have permission to insert user of empty string if not\n */\n",
1576
+ "excerptTokens": [
1577
+ {
1578
+ "kind": "Content",
1579
+ "text": "createEvent: "
1580
+ },
1581
+ {
1582
+ "kind": "Content",
1583
+ "text": "string"
1584
+ },
1585
+ {
1586
+ "kind": "Content",
1587
+ "text": ";"
1588
+ }
1589
+ ],
1590
+ "isReadonly": false,
1591
+ "isOptional": false,
1592
+ "releaseTag": "Public",
1593
+ "name": "createEvent",
1594
+ "propertyTypeTokenRange": {
1595
+ "startIndex": 1,
1596
+ "endIndex": 2
1597
+ },
1598
+ "isStatic": false,
1599
+ "isProtected": false,
1600
+ "isAbstract": false
1601
+ },
1602
+ {
1603
+ "kind": "Method",
1604
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#deepClone:member(1)",
1605
+ "docComment": "",
1606
+ "excerptTokens": [
1607
+ {
1608
+ "kind": "Content",
1609
+ "text": "deepClone(): "
1610
+ },
1611
+ {
1612
+ "kind": "Reference",
1613
+ "text": "Node",
1614
+ "canonicalReference": "!Node:interface"
1615
+ },
1616
+ {
1617
+ "kind": "Content",
1618
+ "text": ";"
1619
+ }
1620
+ ],
1621
+ "isStatic": false,
1622
+ "returnTypeTokenRange": {
1623
+ "startIndex": 1,
1624
+ "endIndex": 2
1625
+ },
1626
+ "releaseTag": "Public",
1627
+ "isProtected": false,
1628
+ "overloadIndex": 1,
1629
+ "parameters": [],
1630
+ "isOptional": false,
1631
+ "isAbstract": false,
1632
+ "name": "deepClone"
1633
+ },
1634
+ {
1635
+ "kind": "Property",
1636
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#deleteEvent:member",
1637
+ "docComment": "/**\n * String which contains event if we have permission to delete user of empty string if not\n */\n",
1638
+ "excerptTokens": [
1639
+ {
1640
+ "kind": "Content",
1641
+ "text": "deleteEvent: "
1642
+ },
1643
+ {
1644
+ "kind": "Content",
1645
+ "text": "string"
1646
+ },
1647
+ {
1648
+ "kind": "Content",
1649
+ "text": ";"
1650
+ }
1651
+ ],
1652
+ "isReadonly": false,
1653
+ "isOptional": false,
1654
+ "releaseTag": "Public",
1655
+ "name": "deleteEvent",
1656
+ "propertyTypeTokenRange": {
1657
+ "startIndex": 1,
1658
+ "endIndex": 2
1659
+ },
1660
+ "isStatic": false,
1661
+ "isProtected": false,
1662
+ "isAbstract": false
1663
+ },
1664
+ {
1665
+ "kind": "Property",
1666
+ "canonicalReference": "@genesislcap/foundation-entity-management!Users#updateEvent:member",
1667
+ "docComment": "/**\n * String which contains event if we have permission to update user of empty string if not\n */\n",
1668
+ "excerptTokens": [
1669
+ {
1670
+ "kind": "Content",
1671
+ "text": "updateEvent: "
1672
+ },
1673
+ {
1674
+ "kind": "Content",
1675
+ "text": "string"
1676
+ },
1677
+ {
1678
+ "kind": "Content",
1679
+ "text": ";"
1680
+ }
1681
+ ],
1682
+ "isReadonly": false,
1683
+ "isOptional": false,
1684
+ "releaseTag": "Public",
1685
+ "name": "updateEvent",
1686
+ "propertyTypeTokenRange": {
1687
+ "startIndex": 1,
1688
+ "endIndex": 2
1689
+ },
1690
+ "isStatic": false,
1691
+ "isProtected": false,
1692
+ "isAbstract": false
1693
+ }
1694
+ ],
1695
+ "extendsTokenRange": {
1696
+ "startIndex": 1,
1697
+ "endIndex": 2
1698
+ },
1699
+ "implementsTokenRanges": []
1700
+ },
1701
+ {
1702
+ "kind": "Variable",
1703
+ "canonicalReference": "@genesislcap/foundation-entity-management!UsersColumnConfig:var",
1704
+ "docComment": "/**\n * Defines the default columns which are present on the user management component\n *\n * @remarks\n *\n * This is exported so you can override and mix-in custom columns along with the default\n *\n * @public\n */\n",
1705
+ "excerptTokens": [
1706
+ {
1707
+ "kind": "Content",
1708
+ "text": "UsersColumnConfig: "
1709
+ },
1710
+ {
1711
+ "kind": "Content",
1712
+ "text": "({\n field: string;\n headerName: string;\n enableCellChangeFlash: boolean;\n enableRowGroup: boolean;\n enablePivot: boolean;\n enableValue: boolean;\n} | {\n field: string;\n headerName: string;\n valueFormatter: ({ value }: {\n value: any;\n }) => string;\n enableCellChangeFlash: boolean;\n enableRowGroup: boolean;\n enablePivot: boolean;\n enableValue: boolean;\n})[]"
1713
+ }
1714
+ ],
1715
+ "fileUrlPath": "src/users/users.ts",
1716
+ "isReadonly": true,
1717
+ "releaseTag": "Public",
1718
+ "name": "UsersColumnConfig",
1719
+ "variableTypeTokenRange": {
1720
+ "startIndex": 1,
1721
+ "endIndex": 2
1722
+ }
1723
+ }
1724
+ ]
1725
+ }
1726
+ ]
1727
+ }