@genesislcap/foundation-user 14.137.0

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

@@ -0,0 +1,13 @@
+<!-- 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

@@ -0,0 +1,12 @@
+<!-- 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.profile.md

@@ -0,0 +1,12 @@
+<!-- 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.rawproperties.md

@@ -0,0 +1,18 @@
+<!-- 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

@@ -0,0 +1,22 @@
+<!-- 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
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  properties | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; | The UserProperties used to populate the User. |
+
+**Returns:**
+
+[User](./foundation-user.user.md)
+

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

@@ -0,0 +1,12 @@
+<!-- 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

@@ -0,0 +1,24 @@
+<!-- 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
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  details | TDetails |  |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,17 @@
+<!-- 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; [trackPath](./foundation-user.defaultuser.trackpath.md)
+
+## DefaultUser.trackPath() method
+
+Track current path.
+
+**Signature:**
+
+```typescript
+trackPath(): string;
+```
+**Returns:**
+
+string
+

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

@@ -0,0 +1,16 @@
+<!-- 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; [unset](./foundation-user.defaultuser.unset.md)
+
+## DefaultUser.unset() method
+
+
+**Signature:**
+
+```typescript
+unset(): User;
+```
+**Returns:**
+
+[User](./foundation-user.user.md)
+

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

@@ -0,0 +1,14 @@
+<!-- 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; [userKVs](./foundation-user.defaultuser.userkvs.md)
+
+## DefaultUser.userKVs property
+
+
+**Signature:**
+
+```typescript
+userKVs: {
+        [key: string]: any;
+    };
+```

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

@@ -0,0 +1,12 @@
+<!-- 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; [userName](./foundation-user.defaultuser.username.md)
+
+## DefaultUser.userName property
+
+
+**Signature:**
+
+```typescript
+userName: string;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [defaultUserConfig](./foundation-user.defaultuserconfig.md)
+
+## defaultUserConfig variable
+
+Default UserConfig DI implementation.
+
+**Signature:**
+
+```typescript
+defaultUserConfig: UserConfig
+```

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [getUser](./foundation-user.getuser.md)
+
+## getUser() function
+
+Gets User from the DI container.
+
+**Signature:**
+
+```typescript
+export declare function getUser(): User;
+```
+**Returns:**
+
+[User](./foundation-user.user.md)
+
+## Remarks
+
+A utility method for host applications that are not using decorators or the DI container.
+
+## Example
+
+
+```ts
+import { getUser, User } from '@genesislcap/foundation-user';
+...
+private user: User = getUser();
+```
+

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

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

package/docs/api/foundation-user.md

@@ -0,0 +1,47 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md)
+
+## foundation-user package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [DefaultUser](./foundation-user.defaultuser.md) | Default User implementation. |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [getUser()](./foundation-user.getuser.md) | Gets User from the DI container. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [SetUserProperties](./foundation-user.setuserproperties.md) | SetUserProperties is a partial match of <code>LoginAck</code> from <code>@genesislcap/foundation-auth</code>. |
+|  [User](./foundation-user.user.md) | User interface. |
+|  [UserActionHistory](./foundation-user.useractionhistory.md) | UserActionHistory. |
+|  [UserConfig](./foundation-user.userconfig.md) | UserConfig DI interface. |
+|  [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) |  |
+|  [UserDetailsProperty](./foundation-user.userdetailsproperty.md) |  |
+|  [UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md) |  |
+|  [UserKVsProperty](./foundation-user.userkvsproperty.md) |  |
+|  [UserPathHistory](./foundation-user.userpathhistory.md) | UserPathHistory. |
+|  [UserQueueProperties](./foundation-user.userqueueproperties.md) |  |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [defaultUserConfig](./foundation-user.defaultuserconfig.md) | Default UserConfig DI implementation. |
+|  [logger](./foundation-user.logger.md) |  |
+|  [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md) | UserAuthenticationChangeType. |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md) | UserAuthenticationChangeEvent. |
+

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

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

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md)
+
+## SetUserProperties interface
+
+SetUserProperties is a partial match of `LoginAck` from `@genesislcap/foundation-auth`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface SetUserProperties extends Partial<UserQueueProperties> 
+```
+**Extends:** Partial&lt;[UserQueueProperties](./foundation-user.userqueueproperties.md)<!-- -->&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [details](./foundation-user.setuserproperties.details.md) | <code>readonly</code> | [UserDetailsProperty](./foundation-user.userdetailsproperty.md) |  |
+|  [permission](./foundation-user.setuserproperties.permission.md) | <code>readonly</code> | string\[\] |  |
+|  [profile](./foundation-user.setuserproperties.profile.md) | <code>readonly</code> | string\[\] |  |
+|  [sourceRef](./foundation-user.setuserproperties.sourceref.md) | <code>readonly</code> | string |  |
+|  [userKVs](./foundation-user.setuserproperties.userkvs.md) | <code>readonly</code> | [UserKVsProperty](./foundation-user.userkvsproperty.md) |  |
+|  [userName](./foundation-user.setuserproperties.username.md) | <code>readonly</code> | string |  |
+

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [addAuthenticationChangeListener](./foundation-user.user.addauthenticationchangelistener.md)
+
+## User.addAuthenticationChangeListener() method
+
+**Signature:**
+
+```typescript
+addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt; | A listener function. |
+
+**Returns:**
+
+() =&gt; void
+
+## Example
+
+
+```ts
+import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
+...
+const unsubscribe = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
+  console.log('User authenticated?', event.detail);
+});
+```
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [clearTrackingHistory](./foundation-user.user.cleartrackinghistory.md)
+
+## User.clearTrackingHistory() method
+
+**Signature:**
+
+```typescript
+clearTrackingHistory(): void;
+```
+**Returns:**
+
+void
+

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

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

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [hasPermission](./foundation-user.user.haspermission.md)
+
+## User.hasPermission() method
+
+**Signature:**
+
+```typescript
+hasPermission(permission: string | string[]): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  permission | string \| string\[\] | A permission string or an array of permission strings to check. |
+
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [hasProfile](./foundation-user.user.hasprofile.md)
+
+## User.hasProfile() method
+
+**Signature:**
+
+```typescript
+hasProfile(profile: string | string[]): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  profile | string \| string\[\] | A profile string or an array of profile strings to check. |
+
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [isAdmin](./foundation-user.user.isadmin.md)
+
+## User.isAdmin() method
+
+**Signature:**
+
+```typescript
+isAdmin(): boolean;
+```
+**Returns:**
+
+boolean
+

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

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

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

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

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [isBanned](./foundation-user.user.isbanned.md)
+
+## User.isBanned() method
+
+**Signature:**
+
+```typescript
+isBanned(): boolean;
+```
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md)
+
+## User interface
+
+User interface.
+
+**Signature:**
+
+```typescript
+export interface User extends UserPathHistory, UserActionHistory 
+```
+**Extends:** [UserPathHistory](./foundation-user.userpathhistory.md)<!-- -->, [UserActionHistory](./foundation-user.useractionhistory.md)
+
+## Remarks
+
+The user singleton, which always exists in either an anonymous or authenticated mode.
+
+## Example
+
+
+```ts
+import { User } from '@genesislcap/foundation-user';
+...
+@User private user: 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 |  |
+|  [userName](./foundation-user.user.username.md) | <code>readonly</code> | string |  |
+
+## 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) |  |
+

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

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

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

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