@genesislcap/foundation-user 14.408.0 → 14.409.0

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

@@ -1,514 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md)
-
-## DefaultUser class
-
-Default User implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultUser implements User 
-```
-**Implements:** [User](./foundation-user.user.md)
-
-## Properties
-
-<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
-
-<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.pathhistory.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [pathHistory](./foundation-user.defaultuser.pathhistory.md)
-
-## DefaultUser.pathHistory property
-
-Array of paths that have been tracked.
-
-**Signature:**
-
-```typescript
-pathHistory: string[];
-```

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [permission](./foundation-user.defaultuser.permission.md)
-
-## DefaultUser.permission property
-
-
-**Signature:**
-
-```typescript
-permission: string[];
-```

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [permissions](./foundation-user.defaultuser.permissions.md)
-
-## DefaultUser.permissions property
-
-**Signature:**
-
-```typescript
-get permissions(): string[];
-```

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [profile](./foundation-user.defaultuser.profile.md)
-
-## DefaultUser.profile property
-
-
-**Signature:**
-
-```typescript
-profile: string[];
-```

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [profiles](./foundation-user.defaultuser.profiles.md)
-
-## DefaultUser.profiles property
-
-**Signature:**
-
-```typescript
-get profiles(): string[];
-```

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

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [rawProperties](./foundation-user.defaultuser.rawproperties.md)
-
-## DefaultUser.rawProperties property
-
-A structuredClone of the raw unmanaged properties used to set the user.
-
-**Signature:**
-
-```typescript
-rawProperties: Partial<SetUserProperties>;
-```
-
-## Remarks
-
-This offers developers an escape hatch to the raw properties. If you feel there's a gap in the User interface based on your application requirements, please raise a request for such properties to be moved onto the interface.
-

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

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [set](./foundation-user.defaultuser.set.md)
-
-## DefaultUser.set() method
-
-**Signature:**
-
-```typescript
-set(properties: Partial<SetUserProperties>): User;
-```
-
-## Parameters
-
-<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:**
-
-[User](./foundation-user.user.md)
-

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [sourceRef](./foundation-user.defaultuser.sourceref.md)
-
-## DefaultUser.sourceRef property
-
-
-**Signature:**
-
-```typescript
-sourceRef: string;
-```

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

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [trackAction](./foundation-user.defaultuser.trackaction.md)
-
-## DefaultUser.trackAction() method
-
-Track an action.
-
-**Signature:**
-
-```typescript
-trackAction<TDetails = unknown>(details: TDetails): void;
-```
-
-## Parameters
-
-<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:**
-
-void
-