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

package/dist/dts/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.9"
+      "packageVersion": "7.52.10"
     }
   ]
 }

package/dist/foundation-user.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.9",
+    "toolVersion": "7.52.10",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {

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

@@ -12,9 +12,39 @@ addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt; | A listener function. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+listener
+
+
+</td><td>
+
+Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt;
+
+
+</td><td>
+
+A listener function.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

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

package/docs/api/foundation-user.defaultuser.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.defaultuser.md

@@ -15,40 +15,500 @@ export declare class DefaultUser implements User
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [actionHistory](./foundation-user.defaultuser.actionhistory.md) |  | unknown\[\] | Array of actions that have been tracked. |
-|  [details](./foundation-user.defaultuser.details.md) |  | [SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->\['details'\] |  |
-|  [isAnonymous](./foundation-user.defaultuser.isanonymous.md) | <code>readonly</code> | boolean |  |
-|  [isAuthenticated](./foundation-user.defaultuser.isauthenticated.md) |  | boolean |  |
-|  [pathHistory](./foundation-user.defaultuser.pathhistory.md) |  | string\[\] | Array of paths that have been tracked. |
-|  [permission](./foundation-user.defaultuser.permission.md) |  | string\[\] |  |
-|  [permissions](./foundation-user.defaultuser.permissions.md) | <code>readonly</code> | string\[\] |  |
-|  [profile](./foundation-user.defaultuser.profile.md) |  | string\[\] |  |
-|  [profiles](./foundation-user.defaultuser.profiles.md) | <code>readonly</code> | string\[\] |  |
-|  [rawProperties](./foundation-user.defaultuser.rawproperties.md) |  | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; | A structuredClone of the raw unmanaged properties used to set the user. |
-|  [sourceRef](./foundation-user.defaultuser.sourceref.md) |  | string |  |
-|  [userKVs](./foundation-user.defaultuser.userkvs.md) |  | { \[key: string\]: any; } |  |
-|  [username](./foundation-user.defaultuser.username.md) | <code>readonly</code> | string |  |
-|  [userName](./foundation-user.defaultuser.username.md) |  | string |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[actionHistory](./foundation-user.defaultuser.actionhistory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+unknown\[\]
+
+
+</td><td>
+
+Array of actions that have been tracked.
+
+
+</td></tr>
+<tr><td>
+
+[details](./foundation-user.defaultuser.details.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->\['details'\]
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[isAnonymous](./foundation-user.defaultuser.isanonymous.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[isAuthenticated](./foundation-user.defaultuser.isauthenticated.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[pathHistory](./foundation-user.defaultuser.pathhistory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+Array of paths that have been tracked.
+
+
+</td></tr>
+<tr><td>
+
+[permission](./foundation-user.defaultuser.permission.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[permissions](./foundation-user.defaultuser.permissions.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[profile](./foundation-user.defaultuser.profile.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[profiles](./foundation-user.defaultuser.profiles.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[rawProperties](./foundation-user.defaultuser.rawproperties.md)
+
+
+</td><td>
+
+
+</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.defaultuser.sourceref.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[userKVs](./foundation-user.defaultuser.userkvs.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[key: string\]: any; }
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[username](./foundation-user.defaultuser.username.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[userName](./foundation-user.defaultuser.username.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [addAuthenticationChangeListener(listener)](./foundation-user.defaultuser.addauthenticationchangelistener.md) |  |  |
-|  [clearActions()](./foundation-user.defaultuser.clearactions.md) |  | Clears action history. |
-|  [clearPaths()](./foundation-user.defaultuser.clearpaths.md) |  | Clears path history. |
-|  [clearTrackingHistory()](./foundation-user.defaultuser.cleartrackinghistory.md) |  |  |
-|  [hasAdminProfile()](./foundation-user.defaultuser.hasadminprofile.md) |  |  |
-|  [hasPermission(permission)](./foundation-user.defaultuser.haspermission.md) |  |  |
-|  [hasProfile(profile)](./foundation-user.defaultuser.hasprofile.md) |  |  |
-|  [isAdmin()](./foundation-user.defaultuser.isadmin.md) |  |  |
-|  [isBanned()](./foundation-user.defaultuser.isbanned.md) |  |  |
-|  [lastAction()](./foundation-user.defaultuser.lastaction.md) |  |  |
-|  [lastPath()](./foundation-user.defaultuser.lastpath.md) |  | May be used to return to a target path after authentication. |
-|  [set(properties)](./foundation-user.defaultuser.set.md) |  |  |
-|  [trackAction(details)](./foundation-user.defaultuser.trackaction.md) |  | Track an action. |
-|  [trackPath()](./foundation-user.defaultuser.trackpath.md) |  | Track current path. |
-|  [unset()](./foundation-user.defaultuser.unset.md) |  |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addAuthenticationChangeListener(listener)](./foundation-user.defaultuser.addauthenticationchangelistener.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[clearActions()](./foundation-user.defaultuser.clearactions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Clears action history.
+
+
+</td></tr>
+<tr><td>
+
+[clearPaths()](./foundation-user.defaultuser.clearpaths.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Clears path history.
+
+
+</td></tr>
+<tr><td>
+
+[clearTrackingHistory()](./foundation-user.defaultuser.cleartrackinghistory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[hasAdminProfile()](./foundation-user.defaultuser.hasadminprofile.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hasPermission(permission)](./foundation-user.defaultuser.haspermission.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hasProfile(profile)](./foundation-user.defaultuser.hasprofile.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isAdmin()](./foundation-user.defaultuser.isadmin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[isBanned()](./foundation-user.defaultuser.isbanned.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[lastAction()](./foundation-user.defaultuser.lastaction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[lastPath()](./foundation-user.defaultuser.lastpath.md)
+
+
+</td><td>
+
+
+</td><td>
+
+May be used to return to a target path after authentication.
+
+
+</td></tr>
+<tr><td>
+
+[set(properties)](./foundation-user.defaultuser.set.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[trackAction(details)](./foundation-user.defaultuser.trackaction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Track an action.
+
+
+</td></tr>
+<tr><td>
+
+[trackPath()](./foundation-user.defaultuser.trackpath.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Track current path.
+
+
+</td></tr>
+<tr><td>
+
+[unset()](./foundation-user.defaultuser.unset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-user.defaultuser.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:**