@genesislcap/foundation-auth 14.136.0 → 14.137.0

package/docs/api/foundation-auth.useractionhistory.lastaction.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserActionHistory](./foundation-auth.useractionhistory.md) &gt; [lastAction](./foundation-auth.useractionhistory.lastaction.md)
-
-## UserActionHistory.lastAction() method
-
-**Signature:**
-
-```typescript
-lastAction(): unknown;
-```
-**Returns:**
-
-unknown
-
-The last stored action.
-

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

@@ -1,32 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserActionHistory](./foundation-auth.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-auth.useractionhistory.actionhistory.md) | <code>readonly</code> | unknown\[\] | Array of actions that have been tracked. |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [clearActions()](./foundation-auth.useractionhistory.clearactions.md) | Clears action history. |
-|  [lastAction()](./foundation-auth.useractionhistory.lastaction.md) |  |
-|  [trackAction(details)](./foundation-auth.useractionhistory.trackaction.md) | Track an action. |
-

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

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserActionHistory](./foundation-auth.useractionhistory.md) &gt; [trackAction](./foundation-auth.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-auth.userauthenticationchangeevent.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserAuthenticationChangeEvent](./foundation-auth.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-auth.userauthenticationchangetype.md

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

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

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserConfig](./foundation-auth.userconfig.md)
-
-## UserConfig interface
-
-UserConfig DI interface.
-
-**Signature:**
-
-```typescript
-export interface UserConfig 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [trackActionExclusions](./foundation-auth.userconfig.trackactionexclusions.md) |  | unknown\[\] | Exclude certain actions from tracking. |
-|  [trackPathExclusions](./foundation-auth.userconfig.trackpathexclusions.md) |  | string\[\] | Exclude certain paths from tracking. |
-

package/docs/api/foundation-auth.userconfig.trackactionexclusions.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserConfig](./foundation-auth.userconfig.md) &gt; [trackActionExclusions](./foundation-auth.userconfig.trackactionexclusions.md)
-
-## UserConfig.trackActionExclusions property
-
-Exclude certain actions from tracking.
-
-**Signature:**
-
-```typescript
-trackActionExclusions: unknown[];
-```

package/docs/api/foundation-auth.userconfig.trackpathexclusions.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserConfig](./foundation-auth.userconfig.md) &gt; [trackPathExclusions](./foundation-auth.userconfig.trackpathexclusions.md)
-
-## UserConfig.trackPathExclusions property
-
-Exclude certain paths from tracking.
-
-**Signature:**
-
-```typescript
-trackPathExclusions: string[];
-```

package/docs/api/foundation-auth.userpathhistory.clearpaths.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserPathHistory](./foundation-auth.userpathhistory.md) &gt; [clearPaths](./foundation-auth.userpathhistory.clearpaths.md)
-
-## UserPathHistory.clearPaths() method
-
-Clears path history.
-
-**Signature:**
-
-```typescript
-clearPaths(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserPathHistory](./foundation-auth.userpathhistory.md) &gt; [lastPath](./foundation-auth.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-auth.userpathhistory.md

@@ -1,32 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserPathHistory](./foundation-auth.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-auth.userpathhistory.pathhistory.md) | <code>readonly</code> | string\[\] | Array of paths that have been tracked. |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [clearPaths()](./foundation-auth.userpathhistory.clearpaths.md) | Clears path history. |
-|  [lastPath()](./foundation-auth.userpathhistory.lastpath.md) | May be used to return to a target path after authentication. |
-|  [trackPath()](./foundation-auth.userpathhistory.trackpath.md) | Track current path. |
-

package/docs/api/foundation-auth.userpathhistory.pathhistory.md

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

package/docs/api/foundation-auth.userpathhistory.trackpath.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserPathHistory](./foundation-auth.userpathhistory.md) &gt; [trackPath](./foundation-auth.userpathhistory.trackpath.md)
-
-## UserPathHistory.trackPath() method
-
-Track current path.
-
-**Signature:**
-
-```typescript
-trackPath(): string;
-```
-**Returns:**
-
-string
-