npm - @genesislcap/foundation-auth - Versions diffs - 14.71.1-auth-mf.21 → 14.99.0-auth-mf.22 - Mend

@genesislcap/foundation-auth 14.71.1-auth-mf.21 → 14.99.0-auth-mf.22

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 (191) hide show

package/docs/api/foundation-auth.authformentrystore.haserrors.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; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [hasErrors](./foundation-auth.authformentrystore.haserrors.md)
-## AuthFormEntryStore.hasErrors property
-**Signature:**
-```typescript
-readonly hasErrors: boolean;
-```

package/docs/api/foundation-auth.authformentrystore.message.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; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [message](./foundation-auth.authformentrystore.message.md)
-## AuthFormEntryStore.message property
-**Signature:**
-```typescript
-readonly message: string;
-```

package/docs/api/foundation-auth.authrouting.getroutepath.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; [AuthRouting](./foundation-auth.authrouting.md) &gt; [getRoutePath](./foundation-auth.authrouting.getroutepath.md)
-## AuthRouting.getRoutePath property
-A utility to get a sub route path taking the host path into account.
-**Signature:**
-```typescript
-getRoutePath: typeof getRoutePath;
-```

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

@@ -1,37 +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; [AuthRouting](./foundation-auth.authrouting.md)
-## AuthRouting interface
-AuthRouting interface.
-**Signature:**
-```typescript
-export interface AuthRouting
-```
-## Remarks
-A utility to navigate to a sub route of the auth micro frontend without needing to know the full path in advance.
-## Example
-Import the utility into any component or logic you wish to invoke from.
-```ts
-import { AuthRouting } from '@genesislcap/foundation-auth/routing';
-...
-@AuthRouting private authRouting: AuthRouting;
-...
-this.authRouting.navigateTo('logout');
-```
-## Properties
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [getRoutePath](./foundation-auth.authrouting.getroutepath.md) |  | typeof getRoutePath | A utility to get a sub route path taking the host path into account. |
-|  [navigateTo](./foundation-auth.authrouting.navigateto.md) |  | typeof navigateTo |  |

package/docs/api/foundation-auth.authrouting.navigateto.md DELETED Viewed

@@ -1,16 +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; [AuthRouting](./foundation-auth.authrouting.md) &gt; [navigateTo](./foundation-auth.authrouting.navigateto.md)
-## AuthRouting.navigateTo property
-**Signature:**
-```typescript
-navigateTo: typeof navigateTo;
-```
-## Remarks
-Uses the `FASTRouter`<!-- -->.

package/docs/api/foundation-auth.defaultauthformentrystore.autofill.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; [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) &gt; [autofill](./foundation-auth.defaultauthformentrystore.autofill.md)
-## DefaultAuthFormEntryStore.autofill() method
-**Signature:**
-```typescript
-protected autofill(): Promise<boolean>;
-```
-**Returns:**
-Promise&lt;boolean&gt;

package/docs/api/foundation-auth.defaultauthformentrystore.fetchmachine.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; [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) &gt; [fetchMachine](./foundation-auth.defaultauthformentrystore.fetchmachine.md)
-## DefaultAuthFormEntryStore.fetchMachine property
-**Signature:**
-```typescript
-readonly fetchMachine: FetchMachine;
-```

package/docs/api/foundation-auth.defaultauthformentrystore.host.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; [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) &gt; [host](./foundation-auth.defaultauthformentrystore.host.md)
-## DefaultAuthFormEntryStore.host property
-**Signature:**
-```typescript
-host: string;
-```

package/docs/api/foundation-auth.defaultauthformentrystore.resetidpstate.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; [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) &gt; [resetIDPState](./foundation-auth.defaultauthformentrystore.resetidpstate.md)
-## DefaultAuthFormEntryStore.resetIDPState() method
-**Signature:**
-```typescript
-protected resetIDPState(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-auth.defaultauthformentrystore.ssotoggledchanged.md DELETED Viewed

@@ -1,23 +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; [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) &gt; [ssoToggledChanged](./foundation-auth.defaultauthformentrystore.ssotoggledchanged.md)
-## DefaultAuthFormEntryStore.ssoToggledChanged() method
-**Signature:**
-```typescript
-protected ssoToggledChanged(prev: boolean, next: boolean): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  prev | boolean |  |
-|  next | boolean |  |
-**Returns:**
-void

package/docs/api/foundation-auth.defaultauthrouting.getroutepath.md DELETED Viewed

@@ -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; [DefaultAuthRouting](./foundation-auth.defaultauthrouting.md) &gt; [getRoutePath](./foundation-auth.defaultauthrouting.getroutepath.md)
-## DefaultAuthRouting.getRoutePath() method
-A utility to get a sub route path taking the host path into account.
-**Signature:**
-```typescript
-getRoutePath(route: AuthRoutes | string): string;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  route | [AuthRoutes](./foundation-auth.authroutes.md) \| string | An auth route. |
-**Returns:**
-string

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

@@ -1,22 +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; [DefaultAuthRouting](./foundation-auth.defaultauthrouting.md)
-## DefaultAuthRouting class
-Default AuthRouting.
-**Signature:**
-```typescript
-export declare class DefaultAuthRouting implements AuthRouting
-```
-**Implements:** [AuthRouting](./foundation-auth.authrouting.md)
-## Methods
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [getRoutePath(route)](./foundation-auth.defaultauthrouting.getroutepath.md) |  | A utility to get a sub route path taking the host path into account. |
-|  [navigateTo(route)](./foundation-auth.defaultauthrouting.navigateto.md) |  |  |

package/docs/api/foundation-auth.defaultauthrouting.navigateto.md DELETED Viewed

@@ -1,26 +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; [DefaultAuthRouting](./foundation-auth.defaultauthrouting.md) &gt; [navigateTo](./foundation-auth.defaultauthrouting.navigateto.md)
-## DefaultAuthRouting.navigateTo() method
-**Signature:**
-```typescript
-navigateTo(route: AuthRoutes | string): void;
-```
-## Parameters
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  route | [AuthRoutes](./foundation-auth.authroutes.md) \| string | An auth route including query params if required, ie. <code>reset-password?expired</code>. |
-**Returns:**
-void
-## Remarks
-Uses the `FASTRouter`<!-- -->.

package/docs/api/foundation-auth.fetchidps.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; [fetchIDPs](./foundation-auth.fetchidps.md)
-## fetchIDPs variable
-Request SSO identity provider list
-**Signature:**
-```typescript
-fetchIDPs: (path?: string, host?: string) => Promise<IDP[]>
-```

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

@@ -1,12 +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; [fromDTONackErrorWarningArray](./foundation-auth.fromdtonackerrorwarningarray.md)
-## fromDTONackErrorWarningArray variable
-**Signature:**
-```typescript
-fromDTONackErrorWarningArray: (arr: NACK_ERROR_WARNING[]) => NackErrorWarning[]
-```

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

@@ -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; [getAuthRouting](./foundation-auth.getauthrouting.md)
-## getAuthRouting() function
-Gets AuthRouting from the DI container.
-**Signature:**
-```typescript
-export declare function getAuthRouting(): AuthRouting;
-```
-**Returns:**
-[AuthRouting](./foundation-auth.authrouting.md)
-## Remarks
-A utility method for host applications that are not using decorators or the DI container.
-## Example
-```ts
-import { getAuthRouting } from '@genesislcap/foundation-auth/routing';
-...
-private authRouting = getAuthRouting();
-...
-this.authRouting.navigateTo('logout');
-```

package/docs/api/foundation-auth.getssologinurl.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; [getSSOLoginURL](./foundation-auth.getssologinurl.md)
-## getSSOLoginURL variable
-Get SSO identity provider login URL
-**Signature:**
-```typescript
-getSSOLoginURL: (idp: any, path?: string, host?: string) => string
-```

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

@@ -1,20 +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; [IDPResponse](./foundation-auth.idpresponse.md)
-## IDPResponse interface
-**Signature:**
-```typescript
-export interface IDPResponse
-```
-## Properties
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [ID](./foundation-auth.idpresponse.id.md) |  | string |  |
-|  [TYPE](./foundation-auth.idpresponse.type.md) |  | string |  |

package/docs/api/foundation-auth.includeserrorwarningcode.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; [includesErrorWarningCode](./foundation-auth.includeserrorwarningcode.md)
-## includesErrorWarningCode variable
-includesErrorWarningCode
-**Signature:**
-```typescript
-includesErrorWarningCode: (arr: NACK_ERROR_WARNING[], code: string) => boolean
-```