npm - @genesislcap/foundation-auth - Versions diffs - 14.408.0 → 14.409.0-FUI-2495.2 - Mend

@genesislcap/foundation-auth 14.408.0 → 14.409.0-FUI-2495.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (328) hide show

package/docs/api/foundation-auth.credentialmanager.storecredentialsincontainer.md DELETED Viewed

@@ -1,56 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [storeCredentialsInContainer](./foundation-auth.credentialmanager.storecredentialsincontainer.md)
-## CredentialManager.storeCredentialsInContainer() method
-Stores the specified credential data in the browser's credential manager.
-**Signature:**
-```typescript
-storeCredentialsInContainer(data: CredentialData): Promise<Credential | undefined>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-data
-</td><td>
-[CredentialData](./foundation-auth.credentialdata_2.md)
-</td><td>
-The credential data to store.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;Credential \| undefined&gt;
-A Promise that resolves to the stored credential object, or `undefined` if storage fails.

package/docs/api/foundation-auth.credentialmanager.storecredentialsincookie.md DELETED Viewed

@@ -1,56 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [storeCredentialsInCookie](./foundation-auth.credentialmanager.storecredentialsincookie.md)
-## CredentialManager.storeCredentialsInCookie() method
-Stores the specified credential data in a browser cookie.
-**Signature:**
-```typescript
-storeCredentialsInCookie(data: CredentialData): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-data
-</td><td>
-[CredentialData](./foundation-auth.credentialdata_2.md)
-</td><td>
-The credential data to store.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-`true` if storage was successful, or `false` otherwise.

package/docs/api/foundation-auth.credentialmanager.validatebasiccredentials.md DELETED Viewed

@@ -1,56 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [validateBasicCredentials](./foundation-auth.credentialmanager.validatebasiccredentials.md)
-## CredentialManager.validateBasicCredentials() method
-Validates basic credentials (username and password).
-**Signature:**
-```typescript
-validateBasicCredentials(credentials: BasicCredentials): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-credentials
-</td><td>
-[BasicCredentials](./foundation-auth.basiccredentials.md)
-</td><td>
-The credentials to validate.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-`true` if the credentials are valid, or `false` otherwise.

package/docs/api/foundation-auth.credentialmanager.validatemfacredentials.md DELETED Viewed

@@ -1,56 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [validateMFACredentials](./foundation-auth.credentialmanager.validatemfacredentials.md)
-## CredentialManager.validateMFACredentials() method
-Validates MFA credentials.
-**Signature:**
-```typescript
-validateMFACredentials(credentials: MFACredentials): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-credentials
-</td><td>
-[MFACredentials](./foundation-auth.mfacredentials.md)
-</td><td>
-The credentials to validate.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-`true` if the credentials are valid, or `false` otherwise.

package/docs/api/foundation-auth.credentialmanager.validaterefreshcredentials.md DELETED Viewed

@@ -1,56 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [validateRefreshCredentials](./foundation-auth.credentialmanager.validaterefreshcredentials.md)
-## CredentialManager.validateRefreshCredentials() method
-Validates refresh credentials.
-**Signature:**
-```typescript
-validateRefreshCredentials(credentials: RefreshCredentials): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-credentials
-</td><td>
-[RefreshCredentials](./foundation-auth.refreshcredentials.md)
-</td><td>
-The credentials to validate.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-`true` if the credentials are valid, or `false` otherwise.

package/docs/api/foundation-auth.credentialmanager.validatessocredentials.md DELETED Viewed

@@ -1,56 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [validateSSOCredentials](./foundation-auth.credentialmanager.validatessocredentials.md)
-## CredentialManager.validateSSOCredentials() method
-Validates SSO credentials.
-**Signature:**
-```typescript
-validateSSOCredentials(credentials: SSOCredentials): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-credentials
-</td><td>
-[SSOCredentials](./foundation-auth.ssocredentials.md)
-</td><td>
-The credentials to validate.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-`true` if the credentials are valid, or `false` otherwise.

package/docs/api/foundation-auth.credentialmanager.validateusercredentialdata.md DELETED Viewed

@@ -1,74 +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; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [validateUserCredentialData](./foundation-auth.credentialmanager.validateusercredentialdata.md)
-## CredentialManager.validateUserCredentialData() method
-Validate user credential data returned from the container or a cookie.
-**Signature:**
-```typescript
-validateUserCredentialData(data: CredentialData, ensurePassword?: boolean): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-data
-</td><td>
-[CredentialData](./foundation-auth.credentialdata_2.md)
-</td><td>
-The credential data to validate.
-</td></tr>
-<tr><td>
-ensurePassword
-</td><td>
-boolean
-</td><td>
-_(Optional)_ Check for the existence of a password. PasswordCredentials will have this, but cookies are considered valid without.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-## Remarks
-This can be called to ensure the credential is in the format this version of the manager expects. This is mainly for dealing with malformed cookies.

package/docs/api/foundation-auth.credentialmanagerconfig.cookie.md DELETED Viewed

@@ -1,11 +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; [CredentialManagerConfig](./foundation-auth.credentialmanagerconfig.md) &gt; [cookie](./foundation-auth.credentialmanagerconfig.cookie.md)
-## CredentialManagerConfig.cookie property
-**Signature:**
-```typescript
-cookie: CredentialManagerCookieConfig;
-```

package/docs/api/foundation-auth.credentialmanagerconfig.md DELETED Viewed

@@ -1,56 +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; [CredentialManagerConfig](./foundation-auth.credentialmanagerconfig.md)
-## CredentialManagerConfig interface
-The configuration for the CredentialManager
-**Signature:**
-```typescript
-export interface CredentialManagerConfig
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[cookie](./foundation-auth.credentialmanagerconfig.cookie.md)
-</td><td>
-</td><td>
-[CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.credentialmanagercookieconfig.expires.md DELETED Viewed

@@ -1,11 +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; [CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md) &gt; [expires](./foundation-auth.credentialmanagercookieconfig.expires.md)
-## CredentialManagerCookieConfig.expires property
-**Signature:**
-```typescript
-expires: number | Date;
-```

package/docs/api/foundation-auth.credentialmanagercookieconfig.md DELETED Viewed

@@ -1,109 +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; [CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md)
-## CredentialManagerCookieConfig interface
-The configuration options for the CredentialManager cookie
-**Signature:**
-```typescript
-export interface CredentialManagerCookieConfig
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[expires](./foundation-auth.credentialmanagercookieconfig.expires.md)
-</td><td>
-</td><td>
-number \| Date
-</td><td>
-</td></tr>
-<tr><td>
-[name](./foundation-auth.credentialmanagercookieconfig.name.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[path](./foundation-auth.credentialmanagercookieconfig.path.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[storePasswords?](./foundation-auth.credentialmanagercookieconfig.storepasswords.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.credentialmanagercookieconfig.name.md DELETED Viewed

@@ -1,11 +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; [CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md) &gt; [name](./foundation-auth.credentialmanagercookieconfig.name.md)
-## CredentialManagerCookieConfig.name property
-**Signature:**
-```typescript
-name: string;
-```

package/docs/api/foundation-auth.credentialmanagercookieconfig.path.md DELETED Viewed

@@ -1,11 +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; [CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md) &gt; [path](./foundation-auth.credentialmanagercookieconfig.path.md)
-## CredentialManagerCookieConfig.path property
-**Signature:**
-```typescript
-path: string;
-```

package/docs/api/foundation-auth.credentialmanagercookieconfig.storepasswords.md DELETED Viewed

@@ -1,11 +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; [CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md) &gt; [storePasswords](./foundation-auth.credentialmanagercookieconfig.storepasswords.md)
-## CredentialManagerCookieConfig.storePasswords property
-**Signature:**
-```typescript
-storePasswords?: boolean;
-```

package/docs/api/foundation-auth.credentials.md DELETED Viewed

@@ -1,15 +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; [Credentials](./foundation-auth.credentials.md)
-## Credentials type
-Union of all credential types.
-**Signature:**
-```typescript
-export type Credentials = BasicCredentials | SSOCredentials | JWTCredentials | RefreshCredentials | MFACredentials;
-```
-**References:** [BasicCredentials](./foundation-auth.basiccredentials.md)<!-- -->, [SSOCredentials](./foundation-auth.ssocredentials.md)<!-- -->, [JWTCredentials](./foundation-auth.jwtcredentials.md)<!-- -->, [RefreshCredentials](./foundation-auth.refreshcredentials.md)<!-- -->, [MFACredentials](./foundation-auth.mfacredentials.md)

package/docs/api/foundation-auth.credentialseparator.md DELETED Viewed

@@ -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; [credentialSeparator](./foundation-auth.credentialseparator.md)
-## credentialSeparator variable
-The default separator used for splitting credential parts.
-**Signature:**
-```typescript
-credentialSeparator = ":"
-```