@genesislcap/foundation-user 14.302.0 → 14.302.1-alpha-945e484.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 (29) hide show
  1. package/dist/dts/tsdoc-metadata.json +1 -1
  2. package/dist/foundation-user.api.json +1 -1
  3. package/docs/api/foundation-user.defaultuser.addauthenticationchangelistener.md +33 -3
  4. package/docs/api/foundation-user.defaultuser.haspermission.md +33 -3
  5. package/docs/api/foundation-user.defaultuser.hasprofile.md +33 -3
  6. package/docs/api/foundation-user.defaultuser.md +493 -33
  7. package/docs/api/foundation-user.defaultuser.set.md +33 -3
  8. package/docs/api/foundation-user.defaultuser.trackaction.md +31 -3
  9. package/docs/api/foundation-user.legacyuserapi.md +100 -8
  10. package/docs/api/foundation-user.md +283 -31
  11. package/docs/api/foundation-user.setuserproperties.md +136 -8
  12. package/docs/api/foundation-user.user.addauthenticationchangelistener.md +33 -3
  13. package/docs/api/foundation-user.user.haspermission.md +33 -3
  14. package/docs/api/foundation-user.user.hasprofile.md +33 -3
  15. package/docs/api/foundation-user.user.md +279 -21
  16. package/docs/api/foundation-user.user.set.md +33 -3
  17. package/docs/api/foundation-user.useractionhistory.md +86 -8
  18. package/docs/api/foundation-user.useractionhistory.trackaction.md +31 -3
  19. package/docs/api/foundation-user.userconfig.md +98 -8
  20. package/docs/api/foundation-user.userconfig.setuser.md +45 -4
  21. package/docs/api/foundation-user.userconfig.unsetuser.md +31 -3
  22. package/docs/api/foundation-user.userdetailsproductproperty.md +60 -4
  23. package/docs/api/foundation-user.userdetailsproperty.md +155 -9
  24. package/docs/api/foundation-user.userdetailssystemproperty.md +41 -3
  25. package/docs/api/foundation-user.userpathhistory.md +88 -8
  26. package/docs/api/foundation-user.userqueueproperties.md +98 -6
  27. package/docs/api/index.md +21 -3
  28. package/docs/api-report.md.api.md +316 -0
  29. package/package.json +12 -12
@@ -14,9 +14,37 @@ trackAction<TDetails = unknown>(details: TDetails): void;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | details | TDetails | |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ details
36
+
37
+
38
+ </td><td>
39
+
40
+ TDetails
41
+
42
+
43
+ </td><td>
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
20
48
 
21
49
  **Returns:**
22
50
 
@@ -16,15 +16,107 @@ For backwards compatibility, will be removed in a future major release, likely v
16
16
 
17
17
  ## Properties
18
18
 
19
- | Property | Modifiers | Type | Description |
20
- | --- | --- | --- | --- |
21
- | [permissions](./foundation-user.legacyuserapi.permissions.md) | <code>readonly</code> | string\[\] | |
22
- | [profiles](./foundation-user.legacyuserapi.profiles.md) | <code>readonly</code> | string\[\] | |
23
- | [username](./foundation-user.legacyuserapi.username.md) | <code>readonly</code> | string | |
19
+ <table><thead><tr><th>
20
+
21
+ Property
22
+
23
+
24
+ </th><th>
25
+
26
+ Modifiers
27
+
28
+
29
+ </th><th>
30
+
31
+ Type
32
+
33
+
34
+ </th><th>
35
+
36
+ Description
37
+
38
+
39
+ </th></tr></thead>
40
+ <tbody><tr><td>
41
+
42
+ [permissions](./foundation-user.legacyuserapi.permissions.md)
43
+
44
+
45
+ </td><td>
46
+
47
+ `readonly`
48
+
49
+
50
+ </td><td>
51
+
52
+ string\[\]
53
+
54
+
55
+ </td><td>
56
+
57
+
58
+ </td></tr>
59
+ <tr><td>
60
+
61
+ [profiles](./foundation-user.legacyuserapi.profiles.md)
62
+
63
+
64
+ </td><td>
65
+
66
+ `readonly`
67
+
68
+
69
+ </td><td>
70
+
71
+ string\[\]
72
+
73
+
74
+ </td><td>
75
+
76
+
77
+ </td></tr>
78
+ <tr><td>
79
+
80
+ [username](./foundation-user.legacyuserapi.username.md)
81
+
82
+
83
+ </td><td>
84
+
85
+ `readonly`
86
+
87
+
88
+ </td><td>
89
+
90
+ string
91
+
92
+
93
+ </td><td>
94
+
95
+
96
+ </td></tr>
97
+ </tbody></table>
24
98
 
25
99
  ## Methods
26
100
 
27
- | Method | Description |
28
- | --- | --- |
29
- | [hasAdminProfile()](./foundation-user.legacyuserapi.hasadminprofile.md) | |
101
+ <table><thead><tr><th>
102
+
103
+ Method
104
+
105
+
106
+ </th><th>
107
+
108
+ Description
109
+
110
+
111
+ </th></tr></thead>
112
+ <tbody><tr><td>
113
+
114
+ [hasAdminProfile()](./foundation-user.legacyuserapi.hasadminprofile.md)
115
+
116
+
117
+ </td><td>
118
+
119
+
120
+ </td></tr>
121
+ </tbody></table>
30
122
 
@@ -6,47 +6,299 @@
6
6
 
7
7
  ## Classes
8
8
 
9
- | Class | Description |
10
- | --- | --- |
11
- | [DefaultUser](./foundation-user.defaultuser.md) | Default User implementation. |
9
+ <table><thead><tr><th>
10
+
11
+ Class
12
+
13
+
14
+ </th><th>
15
+
16
+ Description
17
+
18
+
19
+ </th></tr></thead>
20
+ <tbody><tr><td>
21
+
22
+ [DefaultUser](./foundation-user.defaultuser.md)
23
+
24
+
25
+ </td><td>
26
+
27
+ Default User implementation.
28
+
29
+
30
+ </td></tr>
31
+ </tbody></table>
12
32
 
13
33
  ## Functions
14
34
 
15
- | Function | Description |
16
- | --- | --- |
17
- | [getUser()](./foundation-user.getuser.md) | Gets User from the DI container. |
18
- | [getUserChannel()](./foundation-user.getuserchannel.md) | Gets UserChannel from the DI container. |
35
+ <table><thead><tr><th>
36
+
37
+ Function
38
+
39
+
40
+ </th><th>
41
+
42
+ Description
43
+
44
+
45
+ </th></tr></thead>
46
+ <tbody><tr><td>
47
+
48
+ [getUser()](./foundation-user.getuser.md)
49
+
50
+
51
+ </td><td>
52
+
53
+ Gets User from the DI container.
54
+
55
+
56
+ </td></tr>
57
+ <tr><td>
58
+
59
+ [getUserChannel()](./foundation-user.getuserchannel.md)
60
+
61
+
62
+ </td><td>
63
+
64
+ Gets UserChannel from the DI container.
65
+
66
+
67
+ </td></tr>
68
+ </tbody></table>
19
69
 
20
70
  ## Interfaces
21
71
 
22
- | Interface | Description |
23
- | --- | --- |
24
- | [LegacyUserAPI](./foundation-user.legacyuserapi.md) | |
25
- | [SetUserProperties](./foundation-user.setuserproperties.md) | SetUserProperties is a partial match of <code>LoginAck</code> from <code>@genesislcap/foundation-auth</code>. |
26
- | [User](./foundation-user.user.md) | User interface. |
27
- | [UserActionHistory](./foundation-user.useractionhistory.md) | UserActionHistory. |
28
- | [UserChannel](./foundation-user.userchannel.md) | UserChannel DI interface. |
29
- | [UserConfig](./foundation-user.userconfig.md) | UserConfig DI interface. |
30
- | [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) | |
31
- | [UserDetailsProperty](./foundation-user.userdetailsproperty.md) | |
32
- | [UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md) | |
33
- | [UserKVsProperty](./foundation-user.userkvsproperty.md) | |
34
- | [UserPathHistory](./foundation-user.userpathhistory.md) | UserPathHistory. |
35
- | [UserQueueProperties](./foundation-user.userqueueproperties.md) | |
72
+ <table><thead><tr><th>
73
+
74
+ Interface
75
+
76
+
77
+ </th><th>
78
+
79
+ Description
80
+
81
+
82
+ </th></tr></thead>
83
+ <tbody><tr><td>
84
+
85
+ [LegacyUserAPI](./foundation-user.legacyuserapi.md)
86
+
87
+
88
+ </td><td>
89
+
90
+
91
+ </td></tr>
92
+ <tr><td>
93
+
94
+ [SetUserProperties](./foundation-user.setuserproperties.md)
95
+
96
+
97
+ </td><td>
98
+
99
+ SetUserProperties is a partial match of `LoginAck` from `@genesislcap/foundation-auth`<!-- -->.
100
+
101
+
102
+ </td></tr>
103
+ <tr><td>
104
+
105
+ [User](./foundation-user.user.md)
106
+
107
+
108
+ </td><td>
109
+
110
+ User interface.
111
+
112
+
113
+ </td></tr>
114
+ <tr><td>
115
+
116
+ [UserActionHistory](./foundation-user.useractionhistory.md)
117
+
118
+
119
+ </td><td>
120
+
121
+ UserActionHistory.
122
+
123
+
124
+ </td></tr>
125
+ <tr><td>
126
+
127
+ [UserChannel](./foundation-user.userchannel.md)
128
+
129
+
130
+ </td><td>
131
+
132
+ UserChannel DI interface.
133
+
134
+
135
+ </td></tr>
136
+ <tr><td>
137
+
138
+ [UserConfig](./foundation-user.userconfig.md)
139
+
140
+
141
+ </td><td>
142
+
143
+ UserConfig DI interface.
144
+
145
+
146
+ </td></tr>
147
+ <tr><td>
148
+
149
+ [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)
150
+
151
+
152
+ </td><td>
153
+
154
+
155
+
156
+ </td></tr>
157
+ <tr><td>
158
+
159
+ [UserDetailsProperty](./foundation-user.userdetailsproperty.md)
160
+
161
+
162
+ </td><td>
163
+
164
+
165
+
166
+ </td></tr>
167
+ <tr><td>
168
+
169
+ [UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md)
170
+
171
+
172
+ </td><td>
173
+
174
+
175
+
176
+ </td></tr>
177
+ <tr><td>
178
+
179
+ [UserKVsProperty](./foundation-user.userkvsproperty.md)
180
+
181
+
182
+ </td><td>
183
+
184
+
185
+
186
+ </td></tr>
187
+ <tr><td>
188
+
189
+ [UserPathHistory](./foundation-user.userpathhistory.md)
190
+
191
+
192
+ </td><td>
193
+
194
+ UserPathHistory.
195
+
196
+
197
+ </td></tr>
198
+ <tr><td>
199
+
200
+ [UserQueueProperties](./foundation-user.userqueueproperties.md)
201
+
202
+
203
+ </td><td>
204
+
205
+
206
+
207
+ </td></tr>
208
+ </tbody></table>
36
209
 
37
210
  ## Variables
38
211
 
39
- | Variable | Description |
40
- | --- | --- |
41
- | [defaultUserConfig](./foundation-user.defaultuserconfig.md) | Default UserConfig DI implementation. |
42
- | [logger](./foundation-user.logger.md) | |
43
- | [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md) | UserAuthenticationChangeType. |
44
- | [UserChannelId](./foundation-user.userchannelid.md) | UserChannelId. |
212
+ <table><thead><tr><th>
213
+
214
+ Variable
215
+
216
+
217
+ </th><th>
218
+
219
+ Description
220
+
221
+
222
+ </th></tr></thead>
223
+ <tbody><tr><td>
224
+
225
+ [defaultUserConfig](./foundation-user.defaultuserconfig.md)
226
+
227
+
228
+ </td><td>
229
+
230
+ Default UserConfig DI implementation.
231
+
232
+
233
+ </td></tr>
234
+ <tr><td>
235
+
236
+ [logger](./foundation-user.logger.md)
237
+
238
+
239
+ </td><td>
240
+
241
+
242
+
243
+ </td></tr>
244
+ <tr><td>
245
+
246
+ [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md)
247
+
248
+
249
+ </td><td>
250
+
251
+ UserAuthenticationChangeType.
252
+
253
+
254
+ </td></tr>
255
+ <tr><td>
256
+
257
+ [UserChannelId](./foundation-user.userchannelid.md)
258
+
259
+
260
+ </td><td>
261
+
262
+ UserChannelId.
263
+
264
+
265
+ </td></tr>
266
+ </tbody></table>
45
267
 
46
268
  ## Type Aliases
47
269
 
48
- | Type Alias | Description |
49
- | --- | --- |
50
- | [UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md) | UserAuthenticationChangeEvent. |
51
- | [UserChannelEvents](./foundation-user.userchannelevents.md) | UserChannelEvents. |
270
+ <table><thead><tr><th>
271
+
272
+ Type Alias
273
+
274
+
275
+ </th><th>
276
+
277
+ Description
278
+
279
+
280
+ </th></tr></thead>
281
+ <tbody><tr><td>
282
+
283
+ [UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)
284
+
285
+
286
+ </td><td>
287
+
288
+ UserAuthenticationChangeEvent.
289
+
290
+
291
+ </td></tr>
292
+ <tr><td>
293
+
294
+ [UserChannelEvents](./foundation-user.userchannelevents.md)
295
+
296
+
297
+ </td><td>
298
+
299
+ UserChannelEvents.
300
+
301
+
302
+ </td></tr>
303
+ </tbody></table>
52
304
 
@@ -15,12 +15,140 @@ export interface SetUserProperties extends Partial<UserQueueProperties>
15
15
 
16
16
  ## Properties
17
17
 
18
- | Property | Modifiers | Type | Description |
19
- | --- | --- | --- | --- |
20
- | [details](./foundation-user.setuserproperties.details.md) | <code>readonly</code> | [UserDetailsProperty](./foundation-user.userdetailsproperty.md) | |
21
- | [permission](./foundation-user.setuserproperties.permission.md) | <code>readonly</code> | string\[\] | |
22
- | [profile](./foundation-user.setuserproperties.profile.md) | <code>readonly</code> | string\[\] | |
23
- | [sourceRef](./foundation-user.setuserproperties.sourceref.md) | <code>readonly</code> | string | |
24
- | [userKVs](./foundation-user.setuserproperties.userkvs.md) | <code>readonly</code> | [UserKVsProperty](./foundation-user.userkvsproperty.md) | |
25
- | [userName](./foundation-user.setuserproperties.username.md) | <code>readonly</code> | string | |
18
+ <table><thead><tr><th>
19
+
20
+ Property
21
+
22
+
23
+ </th><th>
24
+
25
+ Modifiers
26
+
27
+
28
+ </th><th>
29
+
30
+ Type
31
+
32
+
33
+ </th><th>
34
+
35
+ Description
36
+
37
+
38
+ </th></tr></thead>
39
+ <tbody><tr><td>
40
+
41
+ [details](./foundation-user.setuserproperties.details.md)
42
+
43
+
44
+ </td><td>
45
+
46
+ `readonly`
47
+
48
+
49
+ </td><td>
50
+
51
+ [UserDetailsProperty](./foundation-user.userdetailsproperty.md)
52
+
53
+
54
+ </td><td>
55
+
56
+
57
+ </td></tr>
58
+ <tr><td>
59
+
60
+ [permission](./foundation-user.setuserproperties.permission.md)
61
+
62
+
63
+ </td><td>
64
+
65
+ `readonly`
66
+
67
+
68
+ </td><td>
69
+
70
+ string\[\]
71
+
72
+
73
+ </td><td>
74
+
75
+
76
+ </td></tr>
77
+ <tr><td>
78
+
79
+ [profile](./foundation-user.setuserproperties.profile.md)
80
+
81
+
82
+ </td><td>
83
+
84
+ `readonly`
85
+
86
+
87
+ </td><td>
88
+
89
+ string\[\]
90
+
91
+
92
+ </td><td>
93
+
94
+
95
+ </td></tr>
96
+ <tr><td>
97
+
98
+ [sourceRef](./foundation-user.setuserproperties.sourceref.md)
99
+
100
+
101
+ </td><td>
102
+
103
+ `readonly`
104
+
105
+
106
+ </td><td>
107
+
108
+ string
109
+
110
+
111
+ </td><td>
112
+
113
+
114
+ </td></tr>
115
+ <tr><td>
116
+
117
+ [userKVs](./foundation-user.setuserproperties.userkvs.md)
118
+
119
+
120
+ </td><td>
121
+
122
+ `readonly`
123
+
124
+
125
+ </td><td>
126
+
127
+ [UserKVsProperty](./foundation-user.userkvsproperty.md)
128
+
129
+
130
+ </td><td>
131
+
132
+
133
+ </td></tr>
134
+ <tr><td>
135
+
136
+ [userName](./foundation-user.setuserproperties.username.md)
137
+
138
+
139
+ </td><td>
140
+
141
+ `readonly`
142
+
143
+
144
+ </td><td>
145
+
146
+ string
147
+
148
+
149
+ </td><td>
150
+
151
+
152
+ </td></tr>
153
+ </tbody></table>
26
154
 
@@ -12,9 +12,39 @@ addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | listener | Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt; | A listener function. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ listener
34
+
35
+
36
+ </td><td>
37
+
38
+ Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt;
39
+
40
+
41
+ </td><td>
42
+
43
+ A listener function.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ hasPermission(permission: string | string[]): boolean;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | permission | string \| string\[\] | A permission string or an array of permission strings to check. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ permission
34
+
35
+
36
+ </td><td>
37
+
38
+ string \| string\[\]
39
+
40
+
41
+ </td><td>
42
+
43
+ A permission string or an array of permission strings to check.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50