@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,26 @@
1
+ import { List } from './list';
2
+ export declare const buttonCellRenderer: (title: any, clickHandler: any) => {
3
+ width: number;
4
+ pinned: string;
5
+ enableCellChangeFlash: boolean;
6
+ cellStyle: {
7
+ padding: string;
8
+ lineHeight: string;
9
+ };
10
+ filter: boolean;
11
+ suppressFiltersToolPanel: boolean;
12
+ suppressColumnsToolPanel: boolean;
13
+ headerName: string;
14
+ minWidth: number;
15
+ maxWidth: number;
16
+ cellRendererSelector: (params: any) => {
17
+ component: string;
18
+ params: {
19
+ actionClick: any;
20
+ actionName: any;
21
+ appearance: string;
22
+ };
23
+ };
24
+ };
25
+ export declare const listTemplate: import("@microsoft/fast-element").ViewTemplate<List, any>;
26
+ //# sourceMappingURL=list.template.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"list.template.d.ts","sourceRoot":"","sources":["../../../src/list/list.template.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;CAsB7B,CAAC;AAEH,eAAO,MAAM,YAAY,2DAiExB,CAAC"}
@@ -0,0 +1,19 @@
1
+ export declare const editProfileFormSchema: {
2
+ type: string;
3
+ elements: ({
4
+ type: string;
5
+ label: string;
6
+ scope: string;
7
+ options?: undefined;
8
+ } | {
9
+ type: string;
10
+ label: string;
11
+ scope: string;
12
+ options: {
13
+ allOptionsResourceName: string;
14
+ valueField: string;
15
+ labelField: string;
16
+ };
17
+ })[];
18
+ };
19
+ //# sourceMappingURL=editProfileSchema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"editProfileSchema.d.ts","sourceRoot":"","sources":["../../../src/profiles/editProfileSchema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;CAuCjC,CAAC"}
@@ -0,0 +1,43 @@
1
+ import { EntityManagement } from '../entities';
2
+ /**
3
+ * Main class which defined the profile management functionality
4
+ *
5
+ * @remarks
6
+ *
7
+ * Under the hood the profile-management is the entity-management micro-frontend configured for use
8
+ * with the `ALL_PROFILES` resource.
9
+ *
10
+ * @public
11
+ *
12
+ * @example
13
+ *
14
+ * You can use this class by forward declaring it in the template file where it is used, and then using
15
+ * it in a html template. It is recommended to wrap it in an error boundary.
16
+ * ```javascript
17
+ * <profile-management></profile-management>
18
+ * ```
19
+ *
20
+ */
21
+ export declare class Profiles extends EntityManagement {
22
+ /**
23
+ * Auth provider which is used to confirm authorisation of the user for their user management permissions
24
+ *
25
+ * @remarks
26
+ *
27
+ * Requires {@link @genesislcap/foundation-comms#Auth | the auth class} to be registered with the
28
+ * DI container
29
+ * @internal
30
+ */
31
+ private auth;
32
+ /**
33
+ * Constructor will set the {@link EntityManagement.createEvent} {@link EntityManagement.deleteEvent} {@link EntityManagement.updateEvent} to match the permissions set from the server
34
+ */
35
+ constructor();
36
+ readProfileData(profile: any): Promise<{
37
+ RIGHT_CODES: any[];
38
+ USER_NAMES: any[];
39
+ NAME: any;
40
+ }>;
41
+ deleteEntity(e: any): Promise<void>;
42
+ }
43
+ //# sourceMappingURL=profiles.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"profiles.d.ts","sourceRoot":"","sources":["../../../src/profiles/profiles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAoB,MAAM,aAAa,CAAC;AAGjE;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAKa,QAAS,SAAQ,gBAAgB;IAC5C;;;;;;;;OAQG;IACG,OAAO,CAAC,IAAI,CAAO;IAEzB;;OAEG;;IAuBU,eAAe,CAAC,OAAO,KAAA;;;;;IAsBrB,YAAY,CAAC,CAAC,KAAA;CAM9B"}
@@ -0,0 +1,3 @@
1
+ export declare const RESOURCE_NAME: import("@microsoft/fast-foundation").InterfaceSymbol<string>;
2
+ export declare const ENTITY_NAME: import("@microsoft/fast-foundation").InterfaceSymbol<string>;
3
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,8DAA6C,CAAC;AACxE,eAAO,MAAM,WAAW,8DAA2C,CAAC"}
@@ -0,0 +1,566 @@
1
+ import { GridProRendererTypes } from '@genesislcap/grid-pro';
2
+ import { FASTElement } from '@microsoft/fast-element';
3
+ import { DatasourceConfiguration } from '../entities';
4
+ /**
5
+ * Defines the default columns which are present on the user management component
6
+ *
7
+ * @remarks
8
+ *
9
+ * This is exported so you can override and mix-in custom columns along with the default
10
+ * @public
11
+ */
12
+ export declare const UsersColumnConfig: ({
13
+ field: string;
14
+ headerName: string;
15
+ enableCellChangeFlash: boolean;
16
+ enableRowGroup: boolean;
17
+ enablePivot: boolean;
18
+ enableValue: boolean;
19
+ } | {
20
+ field: string;
21
+ headerName: string;
22
+ valueFormatter: ({ value }: {
23
+ value: any;
24
+ }) => string;
25
+ enableCellChangeFlash: boolean;
26
+ enableRowGroup: boolean;
27
+ enablePivot: boolean;
28
+ enableValue: boolean;
29
+ })[];
30
+ declare const Users_base: (new (...args: any[]) => {
31
+ "__#1@#_containingLayout": {
32
+ dragging: boolean;
33
+ };
34
+ cloneNode(deep?: boolean): Node;
35
+ deepClone(): Node;
36
+ readonly shouldRunDisconnect: boolean;
37
+ readonly shouldRunConnect: boolean;
38
+ "__#1@#_tryFindContainingLayout"(e: Element): {
39
+ dragging: boolean;
40
+ };
41
+ connectedCallback(): void;
42
+ readonly $fastController: import("@microsoft/fast-element").Controller;
43
+ $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
44
+ disconnectedCallback(): void;
45
+ attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
46
+ accessKey: string;
47
+ readonly accessKeyLabel: string;
48
+ autocapitalize: string;
49
+ dir: string;
50
+ draggable: boolean;
51
+ hidden: boolean;
52
+ inert: boolean;
53
+ innerText: string;
54
+ lang: string;
55
+ readonly offsetHeight: number;
56
+ readonly offsetLeft: number;
57
+ readonly offsetParent: Element;
58
+ readonly offsetTop: number;
59
+ readonly offsetWidth: number;
60
+ outerText: string;
61
+ spellcheck: boolean;
62
+ title: string;
63
+ translate: boolean;
64
+ attachInternals(): ElementInternals;
65
+ click(): void;
66
+ addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
67
+ addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
68
+ removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
69
+ removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
70
+ readonly attributes: NamedNodeMap;
71
+ readonly classList: DOMTokenList;
72
+ className: string;
73
+ readonly clientHeight: number;
74
+ readonly clientLeft: number;
75
+ readonly clientTop: number;
76
+ readonly clientWidth: number;
77
+ id: string;
78
+ readonly localName: string;
79
+ readonly namespaceURI: string;
80
+ onfullscreenchange: (this: Element, ev: Event) => any;
81
+ onfullscreenerror: (this: Element, ev: Event) => any;
82
+ outerHTML: string;
83
+ readonly ownerDocument: Document;
84
+ readonly part: DOMTokenList;
85
+ readonly prefix: string;
86
+ readonly scrollHeight: number;
87
+ scrollLeft: number;
88
+ scrollTop: number;
89
+ readonly scrollWidth: number;
90
+ readonly shadowRoot: ShadowRoot;
91
+ slot: string;
92
+ readonly tagName: string;
93
+ attachShadow(init: ShadowRootInit): ShadowRoot;
94
+ closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
95
+ closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
96
+ closest<E extends Element = Element>(selectors: string): E;
97
+ getAttribute(qualifiedName: string): string;
98
+ getAttributeNS(namespace: string, localName: string): string;
99
+ getAttributeNames(): string[];
100
+ getAttributeNode(qualifiedName: string): Attr;
101
+ getAttributeNodeNS(namespace: string, localName: string): Attr;
102
+ getBoundingClientRect(): DOMRect;
103
+ getClientRects(): DOMRectList;
104
+ getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
105
+ getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
106
+ getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
107
+ getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
108
+ getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
109
+ getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
110
+ getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
111
+ hasAttribute(qualifiedName: string): boolean;
112
+ hasAttributeNS(namespace: string, localName: string): boolean;
113
+ hasAttributes(): boolean;
114
+ hasPointerCapture(pointerId: number): boolean;
115
+ insertAdjacentElement(where: InsertPosition, element: Element): Element;
116
+ insertAdjacentHTML(position: InsertPosition, text: string): void;
117
+ insertAdjacentText(where: InsertPosition, data: string): void;
118
+ matches(selectors: string): boolean;
119
+ releasePointerCapture(pointerId: number): void;
120
+ removeAttribute(qualifiedName: string): void;
121
+ removeAttributeNS(namespace: string, localName: string): void;
122
+ removeAttributeNode(attr: Attr): Attr;
123
+ requestFullscreen(options?: FullscreenOptions): Promise<void>;
124
+ requestPointerLock(): void;
125
+ scroll(options?: ScrollToOptions): void;
126
+ scroll(x: number, y: number): void;
127
+ scrollBy(options?: ScrollToOptions): void;
128
+ scrollBy(x: number, y: number): void;
129
+ scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
130
+ scrollTo(options?: ScrollToOptions): void;
131
+ scrollTo(x: number, y: number): void;
132
+ setAttribute(qualifiedName: string, value: string): void;
133
+ setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
134
+ setAttributeNode(attr: Attr): Attr; /**
135
+ * entityID used to display label from the selector of entityID {@link Users.entityColumn} function.
136
+ * @internal
137
+ */
138
+ setAttributeNodeNS(attr: Attr): Attr;
139
+ setPointerCapture(pointerId: number): void;
140
+ toggleAttribute(qualifiedName: string, force?: boolean): boolean; /**
141
+ * entityID used to control the definition of an optional entity column which is created with the {@link Users.entityColumn} function.
142
+ * @internal
143
+ */
144
+ webkitMatchesSelector(selectors: string): boolean;
145
+ readonly baseURI: string;
146
+ readonly childNodes: NodeListOf<ChildNode>;
147
+ readonly firstChild: ChildNode;
148
+ readonly isConnected: boolean;
149
+ readonly lastChild: ChildNode;
150
+ readonly nextSibling: ChildNode;
151
+ readonly nodeName: string;
152
+ readonly nodeType: number;
153
+ nodeValue: string;
154
+ readonly parentElement: HTMLElement;
155
+ readonly parentNode: ParentNode;
156
+ readonly previousSibling: ChildNode;
157
+ textContent: string;
158
+ appendChild<T_1 extends Node>(node: T_1): T_1;
159
+ compareDocumentPosition(other: Node): number;
160
+ contains(other: Node): boolean;
161
+ getRootNode(options?: GetRootNodeOptions): Node;
162
+ hasChildNodes(): boolean;
163
+ insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
164
+ isDefaultNamespace(namespace: string): boolean;
165
+ isEqualNode(otherNode: Node): boolean;
166
+ isSameNode(otherNode: Node): boolean;
167
+ lookupNamespaceURI(prefix: string): string;
168
+ lookupPrefix(namespace: string): string;
169
+ normalize(): void;
170
+ removeChild<T_3 extends Node>(child: T_3): T_3;
171
+ replaceChild<T_4 extends Node>(node: Node, child: T_4): T_4;
172
+ readonly ATTRIBUTE_NODE: number;
173
+ readonly CDATA_SECTION_NODE: number;
174
+ readonly COMMENT_NODE: number;
175
+ readonly DOCUMENT_FRAGMENT_NODE: number;
176
+ readonly DOCUMENT_NODE: number;
177
+ readonly DOCUMENT_POSITION_CONTAINED_BY: number;
178
+ readonly DOCUMENT_POSITION_CONTAINS: number;
179
+ readonly DOCUMENT_POSITION_DISCONNECTED: number;
180
+ readonly DOCUMENT_POSITION_FOLLOWING: number;
181
+ readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
182
+ readonly DOCUMENT_POSITION_PRECEDING: number;
183
+ readonly DOCUMENT_TYPE_NODE: number;
184
+ readonly ELEMENT_NODE: number;
185
+ readonly ENTITY_NODE: number;
186
+ readonly ENTITY_REFERENCE_NODE: number;
187
+ readonly NOTATION_NODE: number;
188
+ readonly PROCESSING_INSTRUCTION_NODE: number;
189
+ readonly TEXT_NODE: number;
190
+ dispatchEvent(event: Event): boolean;
191
+ ariaAtomic: string;
192
+ ariaAutoComplete: string;
193
+ ariaBusy: string;
194
+ ariaChecked: string;
195
+ ariaColCount: string;
196
+ ariaColIndex: string;
197
+ ariaColIndexText: string;
198
+ ariaColSpan: string;
199
+ ariaCurrent: string;
200
+ ariaDisabled: string; /**
201
+ * Changes the status of an entity
202
+ *
203
+ * @remarks
204
+ *
205
+ * The action which is run on the status button from {@link Users.statusRendererSelector}
206
+ *
207
+ * @internal
208
+ */
209
+ ariaExpanded: string;
210
+ ariaHasPopup: string;
211
+ ariaHidden: string;
212
+ ariaInvalid: string;
213
+ ariaKeyShortcuts: string;
214
+ ariaLabel: string;
215
+ ariaLevel: string;
216
+ ariaLive: string;
217
+ ariaModal: string;
218
+ ariaMultiLine: string;
219
+ ariaMultiSelectable: string;
220
+ ariaOrientation: string;
221
+ ariaPlaceholder: string;
222
+ ariaPosInSet: string;
223
+ ariaPressed: string;
224
+ ariaReadOnly: string;
225
+ ariaRequired: string;
226
+ ariaRoleDescription: string;
227
+ ariaRowCount: string;
228
+ ariaRowIndex: string;
229
+ ariaRowIndexText: string;
230
+ ariaRowSpan: string;
231
+ ariaSelected: string;
232
+ ariaSetSize: string;
233
+ ariaSort: string;
234
+ ariaValueMax: string;
235
+ ariaValueMin: string;
236
+ ariaValueNow: string;
237
+ ariaValueText: string;
238
+ role: string;
239
+ animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
240
+ getAnimations(options?: GetAnimationsOptions): Animation[];
241
+ after(...nodes: (string | Node)[]): void;
242
+ before(...nodes: (string | Node)[]): void;
243
+ remove(): void;
244
+ replaceWith(...nodes: (string | Node)[]): void;
245
+ innerHTML: string;
246
+ readonly nextElementSibling: Element;
247
+ readonly previousElementSibling: Element;
248
+ readonly childElementCount: number;
249
+ readonly children: HTMLCollection;
250
+ readonly firstElementChild: Element;
251
+ readonly lastElementChild: Element;
252
+ append(...nodes: (string | Node)[]): void;
253
+ prepend(...nodes: (string | Node)[]): void;
254
+ querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
255
+ querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
256
+ querySelector<E_1 extends Element = Element>(selectors: string): E_1;
257
+ querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
258
+ querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
259
+ querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
260
+ replaceChildren(...nodes: (string | Node)[]): void;
261
+ readonly assignedSlot: HTMLSlotElement;
262
+ oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
263
+ oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
264
+ onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
265
+ readonly style: CSSStyleDeclaration;
266
+ contentEditable: string;
267
+ enterKeyHint: string;
268
+ inputMode: string;
269
+ readonly isContentEditable: boolean;
270
+ onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
271
+ onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
272
+ onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
273
+ onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
274
+ onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
275
+ onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
276
+ onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
277
+ onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
278
+ oncancel: (this: GlobalEventHandlers, ev: Event) => any;
279
+ oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
280
+ oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
281
+ onchange: (this: GlobalEventHandlers, ev: Event) => any;
282
+ onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
283
+ onclose: (this: GlobalEventHandlers, ev: Event) => any;
284
+ oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
285
+ oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
286
+ ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
287
+ ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
288
+ ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
289
+ ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
290
+ ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
291
+ ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
292
+ ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
293
+ ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
294
+ ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
295
+ onemptied: (this: GlobalEventHandlers, ev: Event) => any;
296
+ onended: (this: GlobalEventHandlers, ev: Event) => any;
297
+ onerror: OnErrorEventHandlerNonNull;
298
+ onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
299
+ onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
300
+ ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
301
+ oninput: (this: GlobalEventHandlers, ev: Event) => any;
302
+ oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
303
+ onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
304
+ onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
305
+ onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
306
+ onload: (this: GlobalEventHandlers, ev: Event) => any;
307
+ onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
308
+ onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
309
+ onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
310
+ onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
311
+ onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
312
+ onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
313
+ onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
314
+ onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
315
+ onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
316
+ onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
317
+ onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
318
+ onpause: (this: GlobalEventHandlers, ev: Event) => any;
319
+ onplay: (this: GlobalEventHandlers, ev: Event) => any;
320
+ onplaying: (this: GlobalEventHandlers, ev: Event) => any;
321
+ onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
322
+ onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
323
+ onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
324
+ onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
325
+ onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
326
+ onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
327
+ onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
328
+ onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
329
+ onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
330
+ onratechange: (this: GlobalEventHandlers, ev: Event) => any;
331
+ onreset: (this: GlobalEventHandlers, ev: Event) => any;
332
+ onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
333
+ onscroll: (this: GlobalEventHandlers, ev: Event) => any;
334
+ onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
335
+ onseeked: (this: GlobalEventHandlers, ev: Event) => any;
336
+ onseeking: (this: GlobalEventHandlers, ev: Event) => any;
337
+ onselect: (this: GlobalEventHandlers, ev: Event) => any;
338
+ onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
339
+ onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
340
+ onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
341
+ onstalled: (this: GlobalEventHandlers, ev: Event) => any;
342
+ onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
343
+ onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
344
+ ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
345
+ ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
346
+ ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
347
+ ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
348
+ ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
349
+ ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
350
+ ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
351
+ ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
352
+ ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
353
+ ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
354
+ onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
355
+ onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
356
+ onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
357
+ onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
358
+ onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
359
+ onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
360
+ onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
361
+ autofocus: boolean;
362
+ readonly dataset: DOMStringMap;
363
+ nonce?: string;
364
+ tabIndex: number;
365
+ blur(): void;
366
+ focus(options?: FocusOptions): void;
367
+ }) & (new () => HTMLElement & FASTElement) & {
368
+ from<TBase extends {
369
+ new (): HTMLElement;
370
+ prototype: HTMLElement;
371
+ }>(BaseType: TBase): new () => InstanceType<TBase> & FASTElement;
372
+ define<TType extends Function>(type: TType, nameOrDef?: string | import("@microsoft/fast-element").PartialFASTElementDefinition): TType;
373
+ };
374
+ /**
375
+ * Main class which defines the user management functionality
376
+ *
377
+ * @remarks
378
+ *
379
+ * Under the hood the user-management is the entity-management micro-frontend configured for use
380
+ * with the `ALL_USERS` resource.
381
+ *
382
+ * @public
383
+ *
384
+ * @example
385
+ *
386
+ * With no customisation required the user management micro-frontend can simply be dropped into the
387
+ * template as shown. However, it is advised to wrap it in an error boundary component.
388
+ * ```javascript
389
+ * <user-management></user-management>
390
+ * ```
391
+ * With this default example above the columns will be the {@link UsersColumnConfig} as well as the
392
+ * entity and status columns. The entity and status
393
+ * columns are always added regardless of the other columns which are configured.
394
+ *
395
+ * You can add in additional customisation options. For example you can define a custom column and
396
+ * then mix-in with the standard columns
397
+ * ```javascript
398
+ * import { Users, UsersColumnConfig, } from '@genesislcap/foundation-entity-management';
399
+ *
400
+ * const userColumns = [
401
+ * {
402
+ * field: 'ACCESS_TYPE',
403
+ * headerName: 'Access Type',
404
+ * },
405
+ * ];
406
+ *
407
+ * // Definition inside of the html template
408
+ * <user-management :columns=${() => [...UsersColumnConfig, ...userColumns]}></user-management>
409
+ * ```
410
+ */
411
+ export declare class Users extends Users_base {
412
+ /**
413
+ * DI connect object which is used to interact with the backend.
414
+ *
415
+ * @remarks
416
+ *
417
+ * Requires {@link @genesislcap/foundation-comms#Connect | the connect class} to be registered with the
418
+ * DI container
419
+ * @internal
420
+ */
421
+ private connect;
422
+ /**
423
+ * Auth provider which is used to confirm authorisation of the user for their user management permissions
424
+ *
425
+ * @remarks
426
+ *
427
+ * Requires {@link @genesislcap/foundation-comms#Auth | the auth class} to be registered with the
428
+ * DI container
429
+ * @internal
430
+ */
431
+ private auth;
432
+ /**
433
+ * The configuration which is used when interacting with the resource on the backend
434
+ *
435
+ * @remarks
436
+ *
437
+ * Handles the configuration such as how many rows of entities to fetch at a time
438
+ * @internal
439
+ */
440
+ datasourceConfig: DatasourceConfiguration;
441
+ /**
442
+ * Configuring the resourceName from the entity-management, set to manage the users resource specifically
443
+ * @internal
444
+ */
445
+ resourceName: string;
446
+ /**
447
+ * Returns a configuration for an optional status column
448
+ *
449
+ * @returns Column configuration for an optional status column
450
+ * @internal
451
+ */
452
+ statusColumn(): {
453
+ headerName: string;
454
+ field: string;
455
+ minWidth: number;
456
+ width: number;
457
+ suppressSizeToFit: boolean;
458
+ cellRendererSelector: any;
459
+ enableCellChangeFlash: boolean;
460
+ enableRowGroup: boolean;
461
+ enablePivot: boolean;
462
+ enableValue: boolean;
463
+ };
464
+ /**
465
+ * Returns the config for an entity column if the entityID attribute is defined
466
+ *
467
+ * @returns Config for an entity column if the entityID is defined, else an empty array
468
+ * @internal
469
+ */
470
+ entityColumn(): {
471
+ headerName: string;
472
+ field: string;
473
+ enableCellChangeFlash: boolean;
474
+ enableRowGroup: boolean;
475
+ enablePivot: boolean;
476
+ enableValue: boolean;
477
+ }[];
478
+ /**
479
+ * Column definition, default to the UsersColumnConfig
480
+ */
481
+ columns: any;
482
+ additionalCreateFields: any;
483
+ additionalUpdateFields: any;
484
+ allAccessType: boolean;
485
+ private entityIdValue;
486
+ /**
487
+ * String which contains event if we have permission to insert user of empty string if not
488
+ */
489
+ createEvent: string;
490
+ /**
491
+ * String which contains event if we have permission to delete user of empty string if not
492
+ */
493
+ deleteEvent: string;
494
+ /**
495
+ * String which contains event if we have permission to update user of empty string if not
496
+ */
497
+ updateEvent: string;
498
+ /**
499
+ * entityID used to control the definition of an optional entity column which is created with the {@link Users.entityColumn} function.
500
+ * @internal
501
+ */
502
+ entityID: string;
503
+ /**
504
+ * entityID used to display label from the selector of entityID {@link Users.entityColumn} function.
505
+ * @internal
506
+ */
507
+ entityLabelKey: string;
508
+ /**
509
+ * entityID used to control the definition of an optional entity column which is created with the {@link Users.entityColumn} function.
510
+ * @internal
511
+ */
512
+ entityLabel: string;
513
+ /**
514
+ * Definition of the `DATASERVER` query which is used when managing Counterpartys
515
+ * @internal
516
+ */
517
+ availableEntitiesEndpoint: string;
518
+ /**
519
+ * Constructor will set the {@link Users.createEvent} {@link Users.deleteEvent} {@link Users.updateEvent} to match the permissions set from the server
520
+ */
521
+ constructor();
522
+ connectedCallback(): Promise<void>;
523
+ deepClone(): Node;
524
+ /**
525
+ * Used as the callback function in {@link Users.statusColumn}
526
+ * @internal
527
+ */
528
+ statusRendererSelector(params: any): {
529
+ component: GridProRendererTypes;
530
+ params: {
531
+ actionClick: () => Promise<void>;
532
+ actionName: string;
533
+ appearance: string;
534
+ };
535
+ };
536
+ /**
537
+ * Changes the status of an entity
538
+ *
539
+ * @remarks
540
+ *
541
+ * The action which is run on the status button from {@link Users.statusRendererSelector}
542
+ *
543
+ * @internal
544
+ */
545
+ changeStatus(params: any): Promise<void>;
546
+ /**
547
+ * @internal
548
+ */
549
+ readUserData(user: any): Promise<{
550
+ USER_PROFILES: any[];
551
+ ADDRESS_LINE_1: any;
552
+ ADDRESS_LINE_2: any;
553
+ ADDRESS_LINE_3: any;
554
+ ADDRESS_LINE_4: any;
555
+ ACCESS_TYPE: string;
556
+ } | {
557
+ USER_PROFILES: any[];
558
+ ADDRESS_LINE_1: any;
559
+ ADDRESS_LINE_2: any;
560
+ ADDRESS_LINE_3: any;
561
+ ADDRESS_LINE_4: any;
562
+ ACCESS_TYPE?: undefined;
563
+ }>;
564
+ }
565
+ export {};
566
+ //# sourceMappingURL=users.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/users/users.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAA4B,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAU,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAW9D;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;IAoC7B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCA2JA;;;OAGG;;;sEAGH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAmEH;;;;;;;;OAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA7OL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBASa,KAAM,SAAQ,UAA2B;IACpD;;;;;;;;OAQG;IACM,OAAO,CAAC,OAAO,CAAU;IAElC;;;;;;;;OAQG;IACG,OAAO,CAAC,IAAI,CAAO;IAEzB;;;;;;;OAOG;IACS,gBAAgB,EAAE,uBAAuB,CAAC;IAEtD;;;OAGG;IACG,YAAY,SAAe;IAEjC;;;;;OAKG;IACI,YAAY;;;;;;;;;;;;IAYnB;;;;;OAKG;IACI,YAAY;;;;;;;;IAYnB;;OAEG;IACS,OAAO,EAAE,GAAG,CAAqB;IAEjC,sBAAsB,EAAE,GAAG,CAAM;IACjC,sBAAsB,EAAE,GAAG,CAAM;IAEjC,aAAa,EAAE,OAAO,CAAC;IACnC,OAAO,CAAC,aAAa,CAAS;IAE9B;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACS,WAAW,EAAE,MAAM,CAAC;IAEhC;;;OAGG;IACG,QAAQ,EAAE,MAAM,CAAqB;IAE3C;;;OAGG;IACG,cAAc,EAAE,MAAM,CAAU;IAEtC;;;OAGG;IACG,WAAW,EAAE,MAAM,CAAkB;IAE3C;;;OAGG;IACG,yBAAyB,EAAE,MAAM,CAAuB;IAE9D;;OAEG;;IAaG,iBAAiB;IAcd,SAAS,IAAI,IAAI;IAc1B;;;OAGG;IACH,sBAAsB,CAAC,MAAM,KAAA;;;;;;;;IAW7B;;;;;;;;OAQG;IACG,YAAY,CAAC,MAAM,KAAA;IAwCzB;;OAEG;IACG,YAAY,CAAC,IAAI,KAAA;;;;;;;;;;;;;;;CAwBxB"}
@@ -0,0 +1,3 @@
1
+ import type { ViewTemplate } from '@microsoft/fast-element';
2
+ export declare const UsersTemplate: ViewTemplate;
3
+ //# sourceMappingURL=users.template.d.ts.map