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

@genesislcap/foundation-auth 14.408.0 → 14.409.0

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.authformentrystore.onselectedidpchanged.md DELETED Viewed

@@ -1,50 +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; [onSelectedIdpChanged](./foundation-auth.authformentrystore.onselectedidpchanged.md)
-## AuthFormEntryStore.onSelectedIdpChanged() method
-**Signature:**
-```typescript
-onSelectedIdpChanged(event: CustomEvent<string>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;string&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authformentrystore.onshowpasswordchanged.md DELETED Viewed

@@ -1,50 +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; [onShowPasswordChanged](./foundation-auth.authformentrystore.onshowpasswordchanged.md)
-## AuthFormEntryStore.onShowPasswordChanged() method
-**Signature:**
-```typescript
-onShowPasswordChanged(event: CustomEvent<boolean>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;boolean&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authformentrystore.onssotogglechanged.md DELETED Viewed

@@ -1,50 +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; [onSSOToggleChanged](./foundation-auth.authformentrystore.onssotogglechanged.md)
-## AuthFormEntryStore.onSSOToggleChanged() method
-**Signature:**
-```typescript
-onSSOToggleChanged(event: CustomEvent<boolean>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;boolean&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-auth.authformentrystore.onusernamechanged.md DELETED Viewed

@@ -1,50 +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; [onUsernameChanged](./foundation-auth.authformentrystore.onusernamechanged.md)
-## AuthFormEntryStore.onUsernameChanged() method
-**Signature:**
-```typescript
-onUsernameChanged(event: CustomEvent<string>): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-CustomEvent&lt;string&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

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

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

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

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

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

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

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

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

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

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

package/docs/api/foundation-auth.authmachine.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; [AuthMachine](./foundation-auth.authmachine.md)
-## AuthMachine interface
-AuthMachine interface.
-**Signature:**
-```typescript
-export interface AuthMachine extends Machine<AuthMachineContext, AuthMachineEvent>
-```
-**Extends:** Machine&lt;[AuthMachineContext](./foundation-auth.authmachinecontext.md)<!-- -->, [AuthMachineEvent](./foundation-auth.authmachineevent.md)<!-- -->&gt;

package/docs/api/foundation-auth.authmachinecontext.dto.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; [AuthMachineContext](./foundation-auth.authmachinecontext.md) &gt; [dto](./foundation-auth.authmachinecontext.dto.md)
-## AuthMachineContext.dto property
-The login/login DTO from the fetch machine.
-**Signature:**
-```typescript
-dto: AuthDTO;
-```

package/docs/api/foundation-auth.authmachinecontext.entity.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; [AuthMachineContext](./foundation-auth.authmachinecontext.md) &gt; [entity](./foundation-auth.authmachinecontext.entity.md)
-## AuthMachineContext.entity property
-The login/login Entity mapped from the DTO.
-**Signature:**
-```typescript
-entity: AuthEntity;
-```

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

@@ -1,120 +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; [AuthMachineContext](./foundation-auth.authmachinecontext.md)
-## AuthMachineContext interface
-AuthMachineContext interface.
-**Signature:**
-```typescript
-export interface AuthMachineContext extends MachineContext
-```
-**Extends:** MachineContext
-## Remarks
-Transient state during the machine's execution.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[dto](./foundation-auth.authmachinecontext.dto.md)
-</td><td>
-</td><td>
-[AuthDTO](./foundation-auth.authdto.md)
-</td><td>
-The login/login DTO from the fetch machine.
-</td></tr>
-<tr><td>
-[entity](./foundation-auth.authmachinecontext.entity.md)
-</td><td>
-</td><td>
-[AuthEntity](./foundation-auth.authentity.md)
-</td><td>
-The login/login Entity mapped from the DTO.
-</td></tr>
-<tr><td>
-[params?](./foundation-auth.authmachinecontext.params.md)
-</td><td>
-</td><td>
-[AuthMachineEventParams](./foundation-auth.authmachineeventparams.md)
-</td><td>
-_(Optional)_ Authentication event params.
-</td></tr>
-<tr><td>
-[user](./foundation-auth.authmachinecontext.user.md)
-</td><td>
-</td><td>
-User
-</td><td>
-The user, either authenticated or anonymous.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.authmachinecontext.params.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; [AuthMachineContext](./foundation-auth.authmachinecontext.md) &gt; [params](./foundation-auth.authmachinecontext.params.md)
-## AuthMachineContext.params property
-Authentication event params.
-**Signature:**
-```typescript
-params?: AuthMachineEventParams;
-```

package/docs/api/foundation-auth.authmachinecontext.user.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; [AuthMachineContext](./foundation-auth.authmachinecontext.md) &gt; [user](./foundation-auth.authmachinecontext.user.md)
-## AuthMachineContext.user property
-The user, either authenticated or anonymous.
-**Signature:**
-```typescript
-user: User;
-```

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

@@ -1,36 +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; [AuthMachineEvent](./foundation-auth.authmachineevent.md)
-## AuthMachineEvent type
-AuthMachineEvent type.
-**Signature:**
-```typescript
-export type AuthMachineEvent = {
-    type: 'login';
-    params: LoginParams;
-} | {
-    type: 'logout';
-} | {
-    type: 'change-password';
-    params: ChangePasswordParams;
-} | {
-    type: 'forgot-password';
-    params: ForgotPasswordParams;
-} | {
-    type: 'reset-password';
-    params: ResetPasswordParams;
-} | {
-    type: 'terms-and-conditions';
-    params: TermsConditionsParams;
-} | DoneInvokeEvent<unknown> | ErrorEvent<unknown>;
-```
-**References:** [LoginParams](./foundation-auth.loginparams.md)<!-- -->, [ChangePasswordParams](./foundation-auth.changepasswordparams.md)<!-- -->, [ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)<!-- -->, [ResetPasswordParams](./foundation-auth.resetpasswordparams.md)<!-- -->, [TermsConditionsParams](./foundation-auth.termsconditionsparams.md)
-## Remarks
-The send action events used to invoke the machine.

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

@@ -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; [AuthMachineEventMap](./foundation-auth.authmachineeventmap.md)
-## AuthMachineEventMap type
-AuthMachineEventMap type.
-**Signature:**
-```typescript
-export type AuthMachineEventMap = {
-    'auth-machine-event': AuthMachineEvent;
-};
-```
-**References:** [AuthMachineEvent](./foundation-auth.authmachineevent.md)
-## Remarks
-The mediation CustomEvent used to invoke machine actions.

package/docs/api/foundation-auth.authmachineeventparams.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; [AuthMachineEventParams](./foundation-auth.authmachineeventparams.md)
-## AuthMachineEventParams type
-AuthMachineEventParams type.
-**Signature:**
-```typescript
-export type AuthMachineEventParams = LoginParams | ForgotPasswordParams | ChangePasswordParams | ResetPasswordParams | QueryParams;
-```
-**References:** [LoginParams](./foundation-auth.loginparams.md)<!-- -->, [ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)<!-- -->, [ChangePasswordParams](./foundation-auth.changepasswordparams.md)<!-- -->, [ResetPasswordParams](./foundation-auth.resetpasswordparams.md)<!-- -->, [QueryParams](./foundation-auth.queryparams.md)

package/docs/api/foundation-auth.authmessagemapper.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; [AuthMessageMapper](./foundation-auth.authmessagemapper.md)
-## AuthMessageMapper interface
-AuthMessageMapper interface.
-**Signature:**
-```typescript
-export interface AuthMessageMapper extends MessageMapper<AuthMessageMapperLookup>
-```
-**Extends:** [MessageMapper](./foundation-auth.messagemapper.md)<!-- -->&lt;[AuthMessageMapperLookup](./foundation-auth.authmessagemapperlookup.md)<!-- -->&gt;

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

@@ -1,27 +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; [AuthMessageMapperLookup](./foundation-auth.authmessagemapperlookup.md)
-## AuthMessageMapperLookup type
-**Signature:**
-```typescript
-export type AuthMessageMapperLookup = {
-    [MESSAGE_TYPE.LOGIN]: LoginMapper;
-    [MESSAGE_TYPE.LOGIN_ACK]: LoginMapper;
-    [MESSAGE_TYPE.LOGIN_NACK]: LoginMapper;
-    [MESSAGE_TYPE.LOGIN_DETAILS_ACK]: LoginMapper;
-    [MESSAGE_TYPE.LOGIN_DETAILS_NACK]: LoginMapper;
-    [MESSAGE_TYPE.LOGOUT_ACK]: LogoutMapper;
-    [MESSAGE_TYPE.LOGOUT_NACK]: LogoutMapper;
-    [MESSAGE_TYPE.FORGOT_PASSWORD]: PasswordManagementMapper;
-    [MESSAGE_TYPE.CHANGE_PASSWORD]: PasswordManagementMapper;
-    [MESSAGE_TYPE.RESET_PASSWORD]: PasswordManagementMapper;
-    [MESSAGE_TYPE.EVENT_NACK]: LogoutMapper;
-    [MESSAGE_TYPE.MSG_NACK]: LogoutMapper;
-};
-```
-**References:** [LoginMapper](./foundation-auth.loginmapper.md)<!-- -->, [LogoutMapper](./foundation-auth.logoutmapper.md)<!-- -->, [PasswordManagementMapper](./foundation-auth.passwordmanagementmapper.md)