@genesislcap/foundation-user 14.302.0 → 14.302.1-alpha-945e484.0

package/docs/api/foundation-user.user.hasprofile.md

@@ -12,9 +12,39 @@ hasProfile(profile: string | string[]): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  profile | string \| string\[\] | A profile string or an array of profile strings to check. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+profile
+
+
+</td><td>
+
+string \| string\[\]
+
+
+</td><td>
+
+A profile string or an array of profile strings to check.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-user.user.md

@@ -28,28 +28,286 @@ import { User } from '@genesislcap/foundation-user';
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [details](./foundation-user.user.details.md) | <code>readonly</code> | [SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->\['details'\] |  |
-|  [isAnonymous](./foundation-user.user.isanonymous.md) | <code>readonly</code> | boolean |  |
-|  [isAuthenticated](./foundation-user.user.isauthenticated.md) | <code>readonly</code> | boolean |  |
-|  [permission](./foundation-user.user.permission.md) | <code>readonly</code> | string\[\] |  |
-|  [profile](./foundation-user.user.profile.md) | <code>readonly</code> | string\[\] |  |
-|  [rawProperties](./foundation-user.user.rawproperties.md) | <code>readonly</code> | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; | A structuredClone of the raw unmanaged properties used to set the user. |
-|  [sourceRef](./foundation-user.user.sourceref.md) | <code>readonly</code> | string |  |
-|  [userKVs](./foundation-user.user.userkvs.md) | <code>readonly</code> | { \[key: string\]: any; } |  |
-|  [userName](./foundation-user.user.username.md) | <code>readonly</code> | string |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[details](./foundation-user.user.details.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->\['details'\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isAnonymous](./foundation-user.user.isanonymous.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isAuthenticated](./foundation-user.user.isauthenticated.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[permission](./foundation-user.user.permission.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[profile](./foundation-user.user.profile.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[rawProperties](./foundation-user.user.rawproperties.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt;
+
+
+</td><td>
+
+A structuredClone of the raw unmanaged properties used to set the user.
+
+
+</td></tr>
+<tr><td>
+
+[sourceRef](./foundation-user.user.sourceref.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[userKVs](./foundation-user.user.userkvs.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+{ \[key: string\]: any; }
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[userName](./foundation-user.user.username.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [addAuthenticationChangeListener(listener)](./foundation-user.user.addauthenticationchangelistener.md) |  |
-|  [clearTrackingHistory()](./foundation-user.user.cleartrackinghistory.md) |  |
-|  [hasPermission(permission)](./foundation-user.user.haspermission.md) |  |
-|  [hasProfile(profile)](./foundation-user.user.hasprofile.md) |  |
-|  [isAdmin()](./foundation-user.user.isadmin.md) |  |
-|  [isBanned()](./foundation-user.user.isbanned.md) |  |
-|  [set(properties)](./foundation-user.user.set.md) |  |
-|  [unset()](./foundation-user.user.unset.md) |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addAuthenticationChangeListener(listener)](./foundation-user.user.addauthenticationchangelistener.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[clearTrackingHistory()](./foundation-user.user.cleartrackinghistory.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hasPermission(permission)](./foundation-user.user.haspermission.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hasProfile(profile)](./foundation-user.user.hasprofile.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isAdmin()](./foundation-user.user.isadmin.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isBanned()](./foundation-user.user.isbanned.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[set(properties)](./foundation-user.user.set.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[unset()](./foundation-user.user.unset.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-user.user.set.md

@@ -12,9 +12,39 @@ set(properties: Partial<SetUserProperties>): User;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  properties | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; | The UserProperties used to populate the User. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+properties
+
+
+</td><td>
+
+Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt;
+
+
+</td><td>
+
+The UserProperties used to populate the User.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-user.useractionhistory.md

@@ -18,15 +18,93 @@ APIs to track a user's action history.
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [actionHistory](./foundation-user.useractionhistory.actionhistory.md) | <code>readonly</code> | unknown\[\] | Array of actions that have been tracked. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[actionHistory](./foundation-user.useractionhistory.actionhistory.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+unknown\[\]
+
+
+</td><td>
+
+Array of actions that have been tracked.
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [clearActions()](./foundation-user.useractionhistory.clearactions.md) | Clears action history. |
-|  [lastAction()](./foundation-user.useractionhistory.lastaction.md) |  |
-|  [trackAction(details)](./foundation-user.useractionhistory.trackaction.md) | Track an action. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[clearActions()](./foundation-user.useractionhistory.clearactions.md)
+
+
+</td><td>
+
+Clears action history.
+
+
+</td></tr>
+<tr><td>
+
+[lastAction()](./foundation-user.useractionhistory.lastaction.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[trackAction(details)](./foundation-user.useractionhistory.trackaction.md)
+
+
+</td><td>
+
+Track an action.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-user.useractionhistory.trackaction.md

@@ -14,9 +14,37 @@ trackAction<TDetails = unknown>(details: TDetails): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  details | TDetails |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+details
+
+
+</td><td>
+
+TDetails
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-user.userconfig.md

@@ -14,15 +14,105 @@ export interface UserConfig
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [trackActionExclusions](./foundation-user.userconfig.trackactionexclusions.md) |  | unknown\[\] | <p>Exclude certain actions from tracking.</p><p>See [UserPathHistory](./foundation-user.userpathhistory.md)</p> |
-|  [trackPathExclusions](./foundation-user.userconfig.trackpathexclusions.md) |  | string\[\] | <p>Exclude certain paths from tracking.</p><p>See [UserActionHistory](./foundation-user.useractionhistory.md)</p> |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[trackActionExclusions](./foundation-user.userconfig.trackactionexclusions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+unknown\[\]
+
+
+</td><td>
+
+Exclude certain actions from tracking.
+
+See [UserPathHistory](./foundation-user.userpathhistory.md)
+
+
+</td></tr>
+<tr><td>
+
+[trackPathExclusions](./foundation-user.userconfig.trackpathexclusions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+Exclude certain paths from tracking.
+
+See [UserActionHistory](./foundation-user.useractionhistory.md)
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [setUser(user, properties)](./foundation-user.userconfig.setuser.md) | User property setter. |
-|  [unsetUser(user)](./foundation-user.userconfig.unsetuser.md) | User property un-setter. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[setUser(user, properties)](./foundation-user.userconfig.setuser.md)
+
+
+</td><td>
+
+User property setter.
+
+
+</td></tr>
+<tr><td>
+
+[unsetUser(user)](./foundation-user.userconfig.unsetuser.md)
+
+
+</td><td>
+
+User property un-setter.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-user.userconfig.setuser.md

@@ -14,10 +14,51 @@ setUser(user: WriteableUser, properties: Partial<SetUserProperties>): User;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  user | WriteableUser |  |
-|  properties | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+user
+
+
+</td><td>
+
+WriteableUser
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+properties
+
+
+</td><td>
+
+Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt;
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**