@genesislcap/foundation-user 14.137.0

package/docs/api/foundation-user.user.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; [User](./foundation-user.user.md) &gt; [rawProperties](./foundation-user.user.rawproperties.md)
+
+## User.rawProperties property
+
+A structuredClone of the raw unmanaged properties used to set the user.
+
+**Signature:**
+
+```typescript
+readonly 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.user.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; [User](./foundation-user.user.md) &gt; [set](./foundation-user.user.set.md)
+
+## User.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.user.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; [User](./foundation-user.user.md) &gt; [sourceRef](./foundation-user.user.sourceref.md)
+
+## User.sourceRef property
+
+**Signature:**
+
+```typescript
+readonly sourceRef: string;
+```

package/docs/api/foundation-user.user.unset.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; [unset](./foundation-user.user.unset.md)
+
+## User.unset() method
+
+**Signature:**
+
+```typescript
+unset(): User;
+```
+**Returns:**
+
+[User](./foundation-user.user.md)
+

package/docs/api/foundation-user.user.userkvs.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; [User](./foundation-user.user.md) &gt; [userKVs](./foundation-user.user.userkvs.md)
+
+## User.userKVs property
+
+**Signature:**
+
+```typescript
+readonly userKVs: {
+        [key: string]: any;
+    };
+```

package/docs/api/foundation-user.user.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; [User](./foundation-user.user.md) &gt; [userName](./foundation-user.user.username.md)
+
+## User.userName property
+
+**Signature:**
+
+```typescript
+readonly userName: string;
+```

package/docs/api/foundation-user.useractionhistory.actionhistory.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [actionHistory](./foundation-user.useractionhistory.actionhistory.md)
+
+## UserActionHistory.actionHistory property
+
+Array of actions that have been tracked.
+
+**Signature:**
+
+```typescript
+readonly actionHistory: unknown[];
+```

package/docs/api/foundation-user.useractionhistory.clearactions.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [clearActions](./foundation-user.useractionhistory.clearactions.md)
+
+## UserActionHistory.clearActions() method
+
+Clears action history.
+
+**Signature:**
+
+```typescript
+clearActions(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-user.useractionhistory.lastaction.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [lastAction](./foundation-user.useractionhistory.lastaction.md)
+
+## UserActionHistory.lastAction() method
+
+**Signature:**
+
+```typescript
+lastAction(): unknown;
+```
+**Returns:**
+
+unknown
+
+The last stored action.
+

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

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserActionHistory](./foundation-user.useractionhistory.md)
+
+## UserActionHistory interface
+
+UserActionHistory.
+
+**Signature:**
+
+```typescript
+export interface UserActionHistory 
+```
+
+## Remarks
+
+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. |
+
+## 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. |
+

package/docs/api/foundation-user.useractionhistory.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [trackAction](./foundation-user.useractionhistory.trackaction.md)
+
+## UserActionHistory.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.userauthenticationchangeevent.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; [UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)
+
+## UserAuthenticationChangeEvent type
+
+UserAuthenticationChangeEvent.
+
+**Signature:**
+
+```typescript
+export type UserAuthenticationChangeEvent = CustomEvent<boolean>;
+```
+
+## Remarks
+
+Detail will either be `true` or `false` to indicate authentication status.
+

package/docs/api/foundation-user.userauthenticationchangetype.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; [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md)
+
+## UserAuthenticationChangeType variable
+
+UserAuthenticationChangeType.
+
+**Signature:**
+
+```typescript
+UserAuthenticationChangeType = "user-authentication-change"
+```

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

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserConfig](./foundation-user.userconfig.md)
+
+## UserConfig interface
+
+UserConfig DI interface.
+
+**Signature:**
+
+```typescript
+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> |
+
+## 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. |
+

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

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserConfig](./foundation-user.userconfig.md) &gt; [setUser](./foundation-user.userconfig.setuser.md)
+
+## UserConfig.setUser() method
+
+User property setter.
+
+**Signature:**
+
+```typescript
+setUser(user: WriteableUser, properties: Partial<SetUserProperties>): User;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  user | WriteableUser |  |
+|  properties | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; |  |
+
+**Returns:**
+
+[User](./foundation-user.user.md)
+
+## Remarks
+
+The user is typically set from the result of a LoginAck.
+

package/docs/api/foundation-user.userconfig.trackactionexclusions.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; [UserConfig](./foundation-user.userconfig.md) &gt; [trackActionExclusions](./foundation-user.userconfig.trackactionexclusions.md)
+
+## UserConfig.trackActionExclusions property
+
+Exclude certain actions from tracking.
+
+See [UserPathHistory](./foundation-user.userpathhistory.md)
+
+**Signature:**
+
+```typescript
+trackActionExclusions: unknown[];
+```

package/docs/api/foundation-user.userconfig.trackpathexclusions.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; [UserConfig](./foundation-user.userconfig.md) &gt; [trackPathExclusions](./foundation-user.userconfig.trackpathexclusions.md)
+
+## UserConfig.trackPathExclusions property
+
+Exclude certain paths from tracking.
+
+See [UserActionHistory](./foundation-user.useractionhistory.md)
+
+**Signature:**
+
+```typescript
+trackPathExclusions: string[];
+```

package/docs/api/foundation-user.userconfig.unsetuser.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; [UserConfig](./foundation-user.userconfig.md) &gt; [unsetUser](./foundation-user.userconfig.unsetuser.md)
+
+## UserConfig.unsetUser() method
+
+User property un-setter.
+
+**Signature:**
+
+```typescript
+unsetUser(user: WriteableUser): User;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  user | WriteableUser |  |
+
+**Returns:**
+
+[User](./foundation-user.user.md)
+

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)
+
+## UserDetailsProductProperty interface
+
+
+**Signature:**
+
+```typescript
+export interface UserDetailsProductProperty 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./foundation-user.userdetailsproductproperty.name.md) | <code>readonly</code> | string |  |
+|  [version](./foundation-user.userdetailsproductproperty.version.md) | <code>readonly</code> | string |  |
+

package/docs/api/foundation-user.userdetailsproductproperty.name.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; [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) &gt; [name](./foundation-user.userdetailsproductproperty.name.md)
+
+## UserDetailsProductProperty.name property
+
+**Signature:**
+
+```typescript
+readonly name: string;
+```

package/docs/api/foundation-user.userdetailsproductproperty.version.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; [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) &gt; [version](./foundation-user.userdetailsproductproperty.version.md)
+
+## UserDetailsProductProperty.version property
+
+**Signature:**
+
+```typescript
+readonly version: string;
+```

package/docs/api/foundation-user.userdetailsproperty.daystopasswordexpiry.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [daysToPasswordExpiry](./foundation-user.userdetailsproperty.daystopasswordexpiry.md)
+
+## UserDetailsProperty.daysToPasswordExpiry property
+
+**Signature:**
+
+```typescript
+readonly daysToPasswordExpiry: number;
+```

package/docs/api/foundation-user.userdetailsproperty.failedloginattempts.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [failedLoginAttempts](./foundation-user.userdetailsproperty.failedloginattempts.md)
+
+## UserDetailsProperty.failedLoginAttempts property
+
+**Signature:**
+
+```typescript
+readonly failedLoginAttempts: number;
+```

package/docs/api/foundation-user.userdetailsproperty.heartbeatintervalsecs.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [heartbeatIntervalSecs](./foundation-user.userdetailsproperty.heartbeatintervalsecs.md)
+
+## UserDetailsProperty.heartbeatIntervalSecs property
+
+**Signature:**
+
+```typescript
+readonly heartbeatIntervalSecs: number;
+```

package/docs/api/foundation-user.userdetailsproperty.lastlogindatetime.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [lastLoginDatetime](./foundation-user.userdetailsproperty.lastlogindatetime.md)
+
+## UserDetailsProperty.lastLoginDatetime property
+
+**Signature:**
+
+```typescript
+readonly lastLoginDatetime: number;
+```

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserDetailsProperty](./foundation-user.userdetailsproperty.md)
+
+## UserDetailsProperty interface
+
+
+**Signature:**
+
+```typescript
+export interface UserDetailsProperty 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [daysToPasswordExpiry](./foundation-user.userdetailsproperty.daystopasswordexpiry.md) | <code>readonly</code> | number |  |
+|  [failedLoginAttempts](./foundation-user.userdetailsproperty.failedloginattempts.md) | <code>readonly</code> | number |  |
+|  [heartbeatIntervalSecs](./foundation-user.userdetailsproperty.heartbeatintervalsecs.md) | <code>readonly</code> | number |  |
+|  [lastLoginDatetime](./foundation-user.userdetailsproperty.lastlogindatetime.md) | <code>readonly</code> | number |  |
+|  [product](./foundation-user.userdetailsproperty.product.md) | <code>readonly</code> | [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)<!-- -->\[\] |  |
+|  [rejectedLoginAttempts](./foundation-user.userdetailsproperty.rejectedloginattempts.md) | <code>readonly</code> | number |  |
+|  [system](./foundation-user.userdetailsproperty.system.md) | <code>readonly</code> | [UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md) |  |
+

package/docs/api/foundation-user.userdetailsproperty.product.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [product](./foundation-user.userdetailsproperty.product.md)
+
+## UserDetailsProperty.product property
+
+**Signature:**
+
+```typescript
+readonly product: UserDetailsProductProperty[];
+```

package/docs/api/foundation-user.userdetailsproperty.rejectedloginattempts.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [rejectedLoginAttempts](./foundation-user.userdetailsproperty.rejectedloginattempts.md)
+
+## UserDetailsProperty.rejectedLoginAttempts property
+
+**Signature:**
+
+```typescript
+readonly rejectedLoginAttempts: number;
+```

package/docs/api/foundation-user.userdetailsproperty.system.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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [system](./foundation-user.userdetailsproperty.system.md)
+
+## UserDetailsProperty.system property
+
+**Signature:**
+
+```typescript
+readonly system: UserDetailsSystemProperty;
+```

package/docs/api/foundation-user.userdetailssystemproperty.date.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; [UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md) &gt; [date](./foundation-user.userdetailssystemproperty.date.md)
+
+## UserDetailsSystemProperty.date property
+
+**Signature:**
+
+```typescript
+readonly date: string;
+```

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md)
+
+## UserDetailsSystemProperty interface
+
+
+**Signature:**
+
+```typescript
+export interface UserDetailsSystemProperty 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [date](./foundation-user.userdetailssystemproperty.date.md) | <code>readonly</code> | string |  |
+

package/docs/api/foundation-user.userkvsproperty.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; [UserKVsProperty](./foundation-user.userkvsproperty.md)
+
+## UserKVsProperty interface
+
+
+**Signature:**
+
+```typescript
+export interface UserKVsProperty 
+```

package/docs/api/foundation-user.userpathhistory.clearpaths.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; [UserPathHistory](./foundation-user.userpathhistory.md) &gt; [clearPaths](./foundation-user.userpathhistory.clearpaths.md)
+
+## UserPathHistory.clearPaths() method
+
+Clears path history.
+
+**Signature:**
+
+```typescript
+clearPaths(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserPathHistory](./foundation-user.userpathhistory.md) &gt; [lastPath](./foundation-user.userpathhistory.lastpath.md)
+
+## UserPathHistory.lastPath() method
+
+May be used to return to a target path after authentication.
+
+**Signature:**
+
+```typescript
+lastPath(): string | undefined;
+```
+**Returns:**
+
+string \| undefined
+
+The last stored path.
+

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

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [UserPathHistory](./foundation-user.userpathhistory.md)
+
+## UserPathHistory interface
+
+UserPathHistory.
+
+**Signature:**
+
+```typescript
+export interface UserPathHistory 
+```
+
+## Remarks
+
+APIs to track a user's path history. Includes the pathname, search and hash only. This is not intended proxy or replace the History API.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [pathHistory](./foundation-user.userpathhistory.pathhistory.md) | <code>readonly</code> | string\[\] | Array of paths that have been tracked. |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [clearPaths()](./foundation-user.userpathhistory.clearpaths.md) | Clears path history. |
+|  [lastPath()](./foundation-user.userpathhistory.lastpath.md) | May be used to return to a target path after authentication. |
+|  [trackPath()](./foundation-user.userpathhistory.trackpath.md) | Track current path. |
+

package/docs/api/foundation-user.userpathhistory.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; [UserPathHistory](./foundation-user.userpathhistory.md) &gt; [pathHistory](./foundation-user.userpathhistory.pathhistory.md)
+
+## UserPathHistory.pathHistory property
+
+Array of paths that have been tracked.
+
+**Signature:**
+
+```typescript
+readonly pathHistory: string[];
+```