@genesislcap/foundation-auth 14.71.1-auth-mf.3 → 14.71.1-auth-mf.6
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.
- package/dist/dts/dto/EVENT_LOGIN_DETAILS_ACK.d.ts +7 -0
- package/dist/dts/dto/EVENT_LOGIN_DETAILS_ACK.d.ts.map +1 -0
- package/dist/dts/dto/index.d.ts +1 -0
- package/dist/dts/dto/index.d.ts.map +1 -1
- package/dist/dts/entity/index.d.ts +1 -0
- package/dist/dts/entity/index.d.ts.map +1 -1
- package/dist/dts/entity/loginDetailsAck.d.ts +7 -0
- package/dist/dts/entity/loginDetailsAck.d.ts.map +1 -0
- package/dist/dts/machine/machine.d.ts +12 -1
- package/dist/dts/machine/machine.d.ts.map +1 -1
- package/dist/dts/machine/types.d.ts +3 -5
- package/dist/dts/machine/types.d.ts.map +1 -1
- package/dist/dts/main/main.d.ts +14 -4
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/dts/mapper/loginMapper.d.ts +16 -4
- package/dist/dts/mapper/loginMapper.d.ts.map +1 -1
- package/dist/dts/routes/base.d.ts +10 -17
- package/dist/dts/routes/base.d.ts.map +1 -1
- package/dist/dts/routes/config.d.ts.map +1 -1
- package/dist/dts/routes/login/login.d.ts +5 -5
- package/dist/dts/routes/login/login.d.ts.map +1 -1
- package/dist/dts/routes/login/login.template.d.ts.map +1 -1
- package/dist/dts/store/auth.d.ts +2 -1
- package/dist/dts/store/auth.d.ts.map +1 -1
- package/dist/dts/store/authFormEntry.d.ts +3 -0
- package/dist/dts/store/authFormEntry.d.ts.map +1 -1
- package/dist/esm/dto/EVENT_LOGIN_DETAILS_ACK.js +1 -0
- package/dist/esm/entity/index.js +1 -0
- package/dist/esm/entity/loginDetailsAck.js +1 -0
- package/dist/esm/machine/machine.js +135 -169
- package/dist/esm/main/main.js +42 -6
- package/dist/esm/mapper/loginMapper.js +17 -1
- package/dist/esm/routes/base.js +3 -34
- package/dist/esm/routes/config.js +0 -2
- package/dist/esm/routes/login/login.js +44 -61
- package/dist/esm/routes/login/login.template.js +20 -9
- package/dist/esm/store/auth.js +1 -0
- package/dist/esm/store/authFormEntry.js +1 -3
- package/dist/foundation-auth.api.json +550 -19
- package/dist/foundation-auth.d.ts +68 -27
- package/docs/api/foundation-auth.auth.loginwithcookies.md +15 -0
- package/docs/api/foundation-auth.auth.loginwithcredentials.md +22 -0
- package/docs/api/{foundation-auth.auth.store.md → foundation-auth.auth.logout.md} +7 -3
- package/docs/api/foundation-auth.auth.md +6 -4
- package/docs/api/foundation-auth.autheventmap.md +0 -1
- package/docs/api/foundation-auth.authformentryeventmap.md +1 -0
- package/docs/api/foundation-auth.authformentrystore.md +1 -0
- package/docs/api/foundation-auth.authformentrystore.onautofillform.md +22 -0
- package/docs/api/foundation-auth.authmachinecontext.authdto.md +1 -1
- package/docs/api/foundation-auth.authmachinecontext.authentity.md +1 -1
- package/docs/api/foundation-auth.authmachinecontext.credentials.md +1 -1
- package/docs/api/foundation-auth.authmachinecontext.md +2 -2
- package/docs/api/foundation-auth.authmachineevent.md +0 -2
- package/docs/api/foundation-auth.authstore.md +1 -0
- package/docs/api/foundation-auth.authstore.onlogindetails.md +22 -0
- package/docs/api/foundation-auth.defaultauthformentrystore.md +1 -0
- package/docs/api/foundation-auth.defaultauthformentrystore.onautofillform.md +11 -0
- package/docs/api/foundation-auth.defaultauthmachine.addloginevents.md +23 -0
- package/docs/api/foundation-auth.defaultauthmachine.createfetchmachineevent.md +23 -0
- package/docs/api/foundation-auth.defaultauthmachine.md +2 -0
- package/docs/api/foundation-auth.defaultauthstore.md +1 -0
- package/docs/api/foundation-auth.defaultauthstore.onlogindetails.md +11 -0
- package/docs/api/foundation-auth.event_login_details_ack.md +14 -0
- package/docs/api/foundation-auth.islogindetailsackdto.md +24 -0
- package/docs/api/foundation-auth.islogindetailsackentity.md +24 -0
- package/docs/api/foundation-auth.logindetailsack.md +14 -0
- package/docs/api/foundation-auth.logindto.md +2 -2
- package/docs/api/foundation-auth.loginentity.md +2 -2
- package/docs/api/foundation-auth.md +4 -0
- package/docs/api-report.md +54 -15
- package/package.json +11 -11
|
@@ -17,6 +17,7 @@ import { EmitReturn } from '@genesislcap/foundation-events';
|
|
|
17
17
|
import type { ErrorEvent as ErrorEvent_2 } from 'xstate';
|
|
18
18
|
import { FASTElement } from '@microsoft/fast-element';
|
|
19
19
|
import { FetchMachine } from '@genesislcap/foundation-state-machine';
|
|
20
|
+
import { FetchMachineEvent } from '@genesislcap/foundation-state-machine';
|
|
20
21
|
import { FoundationAnalytics } from '@genesislcap/foundation-comms';
|
|
21
22
|
import { GenesisServerError } from '@genesislcap/foundation-state-machine';
|
|
22
23
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
@@ -28,6 +29,7 @@ import { Machine } from '@genesislcap/foundation-state-machine';
|
|
|
28
29
|
import type { MachineContext } from '@genesislcap/foundation-state-machine';
|
|
29
30
|
import { Message as Message_2 } from '@genesislcap/foundation-comms';
|
|
30
31
|
import { MessageBuilder } from '@genesislcap/foundation-comms';
|
|
32
|
+
import { NavigationPhase } from '@microsoft/fast-router';
|
|
31
33
|
import { PartialFASTElementDefinition } from '@microsoft/fast-element';
|
|
32
34
|
import { RouterConfiguration } from '@microsoft/fast-router';
|
|
33
35
|
import { Session } from '@genesislcap/foundation-comms';
|
|
@@ -55,7 +57,14 @@ declare interface Ack extends Message {
|
|
|
55
57
|
* @public
|
|
56
58
|
*/
|
|
57
59
|
export declare class Auth extends Auth_base {
|
|
60
|
+
/**
|
|
61
|
+
* @internal
|
|
62
|
+
*/
|
|
58
63
|
store: AuthStore;
|
|
64
|
+
/**
|
|
65
|
+
* @internal
|
|
66
|
+
*/
|
|
67
|
+
cm: CredentialManager;
|
|
59
68
|
/**
|
|
60
69
|
* Configuration for the routes and their associated settings.
|
|
61
70
|
* The client would override this in their app with their own settings to set
|
|
@@ -92,7 +101,7 @@ export declare class Auth extends Auth_base {
|
|
|
92
101
|
*/
|
|
93
102
|
disconnectedCallback(): void;
|
|
94
103
|
/**
|
|
95
|
-
* Used to forward the user onto a logged-in session during an SSO
|
|
104
|
+
* Used to forward the user onto a logged-in session during an SSO and MFA journeys
|
|
96
105
|
*
|
|
97
106
|
* @remarks
|
|
98
107
|
*
|
|
@@ -113,7 +122,7 @@ export declare class Auth extends Auth_base {
|
|
|
113
122
|
*
|
|
114
123
|
* @internal
|
|
115
124
|
*/
|
|
116
|
-
|
|
125
|
+
actionQueryParams(): void;
|
|
117
126
|
/**
|
|
118
127
|
* Called from the connectedCallback
|
|
119
128
|
* @internal
|
|
@@ -135,10 +144,13 @@ export declare class Auth extends Auth_base {
|
|
|
135
144
|
* @internal
|
|
136
145
|
*/
|
|
137
146
|
protected readyStore(): void;
|
|
147
|
+
loginWithCredentials(credentials: AuthInfo): void;
|
|
148
|
+
loginWithCookies(): void;
|
|
149
|
+
logout(): void;
|
|
138
150
|
}
|
|
139
151
|
|
|
140
152
|
declare const Auth_base: abstract new (...args: any[]) => {
|
|
141
|
-
$emit<K extends "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-
|
|
153
|
+
$emit<K extends "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-details" | "auth-logout">(...args: AuthEventMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: AuthEventMap[K], options?: EmitOptions]): EmitReturn;
|
|
142
154
|
accessKey: string;
|
|
143
155
|
readonly accessKeyLabel: string;
|
|
144
156
|
autocapitalize: string;
|
|
@@ -613,7 +625,6 @@ export declare class AuthError extends GenesisServerError {
|
|
|
613
625
|
*/
|
|
614
626
|
export declare type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap & {
|
|
615
627
|
'auth-login': AuthInfo;
|
|
616
|
-
'auth-login-refresh': void;
|
|
617
628
|
'auth-login-details': void;
|
|
618
629
|
'auth-logout': void;
|
|
619
630
|
};
|
|
@@ -622,6 +633,7 @@ export declare type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap
|
|
|
622
633
|
* @public
|
|
623
634
|
*/
|
|
624
635
|
export declare type AuthFormEntryEventMap = {
|
|
636
|
+
'auth-autofill-form': void;
|
|
625
637
|
'auth-organisation-changed': string;
|
|
626
638
|
'auth-username-changed': string;
|
|
627
639
|
'auth-email-changed': string;
|
|
@@ -658,6 +670,7 @@ export declare interface AuthFormEntryStore extends Store {
|
|
|
658
670
|
onPasswordChanged(event: CustomEvent<string>): void;
|
|
659
671
|
onPassword2Changed(event: CustomEvent<string>): void;
|
|
660
672
|
onShowPasswordsChanged(event: CustomEvent<boolean>): void;
|
|
673
|
+
onAutofillForm(event: CustomEvent<void>): void;
|
|
661
674
|
}
|
|
662
675
|
|
|
663
676
|
/**
|
|
@@ -699,15 +712,15 @@ export declare interface AuthMachineContext extends MachineContext {
|
|
|
699
712
|
/**
|
|
700
713
|
* The authentication credentials.
|
|
701
714
|
* @remarks
|
|
702
|
-
*
|
|
715
|
+
* Optional as it's possible to reauthenticate silently.
|
|
703
716
|
*/
|
|
704
717
|
credentials?: AuthInfo;
|
|
705
718
|
/**
|
|
706
|
-
* The login/login
|
|
719
|
+
* The login/login DTO from the fetch machine.
|
|
707
720
|
*/
|
|
708
721
|
authDTO: AuthDTO;
|
|
709
722
|
/**
|
|
710
|
-
* The login/login
|
|
723
|
+
* The login/login Entity mapped from the DTO.
|
|
711
724
|
*/
|
|
712
725
|
authEntity: AuthEntity;
|
|
713
726
|
/**
|
|
@@ -731,8 +744,6 @@ export declare type AuthMachineEvent = {
|
|
|
731
744
|
params: {
|
|
732
745
|
credentials?: AuthInfo;
|
|
733
746
|
};
|
|
734
|
-
} | {
|
|
735
|
-
type: 'refresh';
|
|
736
747
|
} | {
|
|
737
748
|
type: 'logout';
|
|
738
749
|
} | {
|
|
@@ -771,6 +782,7 @@ export declare interface AuthStore extends StoreRoot {
|
|
|
771
782
|
*/
|
|
772
783
|
onMachineEvent(event: CustomEvent<AuthEventMap['auth-machine-event']>): void;
|
|
773
784
|
onLogin(event: CustomEvent<AuthInfo>): void;
|
|
785
|
+
onLoginDetails(event: CustomEvent<void>): void;
|
|
774
786
|
onLogout(event: CustomEvent<void>): void;
|
|
775
787
|
}
|
|
776
788
|
|
|
@@ -800,7 +812,6 @@ export declare class BackgroundElement extends ConfigHostElement {
|
|
|
800
812
|
export declare class BaseRoute extends ConfigHostElement {
|
|
801
813
|
store: AuthStore;
|
|
802
814
|
user: User;
|
|
803
|
-
authMachine: AuthMachine;
|
|
804
815
|
auth: Auth_2;
|
|
805
816
|
connect: Connect;
|
|
806
817
|
session: Session;
|
|
@@ -816,7 +827,9 @@ export declare class BaseRoute extends ConfigHostElement {
|
|
|
816
827
|
message: string;
|
|
817
828
|
hasErrors: boolean;
|
|
818
829
|
isSubmitting: boolean;
|
|
830
|
+
protected navigationPhase: NavigationPhase<Settings>;
|
|
819
831
|
connectedCallback(): void;
|
|
832
|
+
enter(phase: NavigationPhase<Settings>): void;
|
|
820
833
|
onSubmit(): Promise<void>;
|
|
821
834
|
ensureConnection(): Promise<boolean>;
|
|
822
835
|
setError(message: string): void;
|
|
@@ -850,7 +863,11 @@ export declare class ConfigHostElement extends ConfigHostElement_base implements
|
|
|
850
863
|
}
|
|
851
864
|
|
|
852
865
|
declare const ConfigHostElement_base: abstract new (...args: any[]) => {
|
|
853
|
-
$emit<K extends "auth-organisation-changed" | "auth-username-changed" | "auth-email-changed" | "auth-password-changed" | "auth-password2-changed" | "auth-showPasswords-changed" | "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-
|
|
866
|
+
$emit<K extends "auth-autofill-form" | "auth-organisation-changed" | "auth-username-changed" | "auth-email-changed" | "auth-password-changed" | "auth-password2-changed" | "auth-showPasswords-changed" | "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-details" | "auth-logout">(...args: EventMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: EventMap[K], options?: EmitOptions]): EmitReturn; /**
|
|
867
|
+
* Fill with default values from config / env vars if needed.
|
|
868
|
+
* For now using CredentialManager based auto-filling.
|
|
869
|
+
* TODO: Review use cases.
|
|
870
|
+
*/
|
|
854
871
|
accessKey: string;
|
|
855
872
|
readonly accessKeyLabel: string;
|
|
856
873
|
autocapitalize: string;
|
|
@@ -935,13 +952,7 @@ declare const ConfigHostElement_base: abstract new (...args: any[]) => {
|
|
|
935
952
|
scrollBy(options?: ScrollToOptions): void;
|
|
936
953
|
scrollBy(x: number, y: number): void;
|
|
937
954
|
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
938
|
-
/**
|
|
939
|
-
* @internal
|
|
940
|
-
*/
|
|
941
955
|
scrollTo(options?: ScrollToOptions): void;
|
|
942
|
-
/**
|
|
943
|
-
* @internal
|
|
944
|
-
*/
|
|
945
956
|
scrollTo(x: number, y: number): void;
|
|
946
957
|
setAttribute(qualifiedName: string, value: string): void;
|
|
947
958
|
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
@@ -1171,14 +1182,6 @@ declare const ConfigHostElement_base: abstract new (...args: any[]) => {
|
|
|
1171
1182
|
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
1172
1183
|
};
|
|
1173
1184
|
|
|
1174
|
-
/**
|
|
1175
|
-
* @internal
|
|
1176
|
-
* @privateRemarks
|
|
1177
|
-
* Potential optimisation ahead of workflow / statemachine based smart forms integration, but needs tagFor.
|
|
1178
|
-
* Feels a bit at odds with the declarative nature we're aiming for, but will await review.
|
|
1179
|
-
*/
|
|
1180
|
-
export declare const configurableTextField: <T extends ConfigHost>(name: keyof FieldConfigMap | [name: keyof FieldConfigMap, valueKey: string], type: string, autofocus?: boolean, autocomplete?: string, className?: string, labelOverride?: string, testIdOverride?: string, required?: boolean) => ViewTemplate<T, any>;
|
|
1181
|
-
|
|
1182
1185
|
/**
|
|
1183
1186
|
* Configure the auth micro frontend settings.
|
|
1184
1187
|
*
|
|
@@ -1268,6 +1271,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
1268
1271
|
onPasswordChanged: EventListener;
|
|
1269
1272
|
onPassword2Changed: EventListener;
|
|
1270
1273
|
onShowPasswordsChanged: EventListener;
|
|
1274
|
+
onAutofillForm: EventListener;
|
|
1271
1275
|
}
|
|
1272
1276
|
|
|
1273
1277
|
/**
|
|
@@ -1290,6 +1294,16 @@ export declare class DefaultAuthMachine extends AbstractMachine<AuthMachineConte
|
|
|
1290
1294
|
* AuthMachine is a singleton.
|
|
1291
1295
|
*/
|
|
1292
1296
|
getFromContainer(): this;
|
|
1297
|
+
createFetchMachineEvent(url: string, msg?: Message_2): FetchMachineEvent;
|
|
1298
|
+
addLoginEvents(): {
|
|
1299
|
+
login: {
|
|
1300
|
+
actions: string[];
|
|
1301
|
+
target: string;
|
|
1302
|
+
};
|
|
1303
|
+
"login-details": {
|
|
1304
|
+
target: string;
|
|
1305
|
+
};
|
|
1306
|
+
};
|
|
1293
1307
|
}
|
|
1294
1308
|
|
|
1295
1309
|
/**
|
|
@@ -1310,6 +1324,7 @@ export declare class DefaultAuthStore extends AbstractStoreRoot<AuthStore, AuthE
|
|
|
1310
1324
|
get isPending(): boolean;
|
|
1311
1325
|
onMachineEvent: EventListener;
|
|
1312
1326
|
onLogin: EventListener;
|
|
1327
|
+
onLoginDetails: EventListener;
|
|
1313
1328
|
onLogout: EventListener;
|
|
1314
1329
|
}
|
|
1315
1330
|
|
|
@@ -1517,6 +1532,12 @@ export declare interface EVENT_LOGIN_AUTH_ACK extends ACK {
|
|
|
1517
1532
|
export declare interface EVENT_LOGIN_AUTH_NACK extends NACK {
|
|
1518
1533
|
}
|
|
1519
1534
|
|
|
1535
|
+
/**
|
|
1536
|
+
* @public
|
|
1537
|
+
*/
|
|
1538
|
+
export declare interface EVENT_LOGIN_DETAILS_ACK extends EVENT_LOGIN_AUTH_ACK {
|
|
1539
|
+
}
|
|
1540
|
+
|
|
1520
1541
|
/**
|
|
1521
1542
|
* @public
|
|
1522
1543
|
*/
|
|
@@ -1673,6 +1694,20 @@ export declare function isLoginAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_AUTH_AC
|
|
|
1673
1694
|
*/
|
|
1674
1695
|
export declare function isLoginAckEntity(entity: LoginEntity): entity is LoginAck;
|
|
1675
1696
|
|
|
1697
|
+
/**
|
|
1698
|
+
* isLoginDetailsAckDTO.
|
|
1699
|
+
* @param dto - Potential DTO.
|
|
1700
|
+
* @public
|
|
1701
|
+
*/
|
|
1702
|
+
export declare function isLoginDetailsAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_DETAILS_ACK;
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* isLoginDetailsAckEntity.
|
|
1706
|
+
* @param entity - Potential entity.
|
|
1707
|
+
* @public
|
|
1708
|
+
*/
|
|
1709
|
+
export declare function isLoginDetailsAckEntity(entity: LoginEntity): entity is LoginDetailsAck;
|
|
1710
|
+
|
|
1676
1711
|
/**
|
|
1677
1712
|
* isLoginNackDTO.
|
|
1678
1713
|
* @param dto - Potential DTO.
|
|
@@ -1766,17 +1801,23 @@ export declare interface LoginAck extends Ack {
|
|
|
1766
1801
|
readonly profile: string[];
|
|
1767
1802
|
}
|
|
1768
1803
|
|
|
1804
|
+
/**
|
|
1805
|
+
* @public
|
|
1806
|
+
*/
|
|
1807
|
+
export declare interface LoginDetailsAck extends LoginAck {
|
|
1808
|
+
}
|
|
1809
|
+
|
|
1769
1810
|
/**
|
|
1770
1811
|
* LoginDTO type.
|
|
1771
1812
|
* @public
|
|
1772
1813
|
*/
|
|
1773
|
-
export declare type LoginDTO = EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_AUTH_NACK;
|
|
1814
|
+
export declare type LoginDTO = EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_DETAILS_ACK | EVENT_LOGIN_AUTH_NACK;
|
|
1774
1815
|
|
|
1775
1816
|
/**
|
|
1776
1817
|
* LoginEntity type.
|
|
1777
1818
|
* @public
|
|
1778
1819
|
*/
|
|
1779
|
-
export declare type LoginEntity = LoginAck | LoginNack;
|
|
1820
|
+
export declare type LoginEntity = LoginAck | LoginDetailsAck | LoginNack;
|
|
1780
1821
|
|
|
1781
1822
|
/**
|
|
1782
1823
|
* LoginMapper interface.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [Auth](./foundation-auth.auth.md) > [loginWithCookies](./foundation-auth.auth.loginwithcookies.md)
|
|
4
|
+
|
|
5
|
+
## Auth.loginWithCookies() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
loginWithCookies(): void;
|
|
11
|
+
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
void
|
|
15
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [Auth](./foundation-auth.auth.md) > [loginWithCredentials](./foundation-auth.auth.loginwithcredentials.md)
|
|
4
|
+
|
|
5
|
+
## Auth.loginWithCredentials() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
loginWithCredentials(credentials: AuthInfo): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| credentials | AuthInfo | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [Auth](./foundation-auth.auth.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [Auth](./foundation-auth.auth.md) > [logout](./foundation-auth.auth.logout.md)
|
|
4
4
|
|
|
5
|
-
## Auth.
|
|
5
|
+
## Auth.logout() method
|
|
6
6
|
|
|
7
7
|
**Signature:**
|
|
8
8
|
|
|
9
9
|
```typescript
|
|
10
|
-
|
|
10
|
+
logout(): void;
|
|
11
11
|
```
|
|
12
|
+
**Returns:**
|
|
13
|
+
|
|
14
|
+
void
|
|
15
|
+
|
|
@@ -12,9 +12,11 @@ export declare class Auth extends Auth_base
|
|
|
12
12
|
```
|
|
13
13
|
**Extends:** Auth\_base
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## Methods
|
|
16
16
|
|
|
17
|
-
|
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| [
|
|
17
|
+
| Method | Modifiers | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| [loginWithCookies()](./foundation-auth.auth.loginwithcookies.md) | | |
|
|
20
|
+
| [loginWithCredentials(credentials)](./foundation-auth.auth.loginwithcredentials.md) | | |
|
|
21
|
+
| [logout()](./foundation-auth.auth.logout.md) | | |
|
|
20
22
|
|
|
@@ -39,6 +39,7 @@ export interface AuthFormEntryStore extends Store
|
|
|
39
39
|
|
|
40
40
|
| Method | Description |
|
|
41
41
|
| --- | --- |
|
|
42
|
+
| [onAutofillForm(event)](./foundation-auth.authformentrystore.onautofillform.md) | |
|
|
42
43
|
| [onEmailChanged(event)](./foundation-auth.authformentrystore.onemailchanged.md) | |
|
|
43
44
|
| [onOrganisationChanged(event)](./foundation-auth.authformentrystore.onorganisationchanged.md) | |
|
|
44
45
|
| [onPassword2Changed(event)](./foundation-auth.authformentrystore.onpassword2changed.md) | |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [AuthFormEntryStore](./foundation-auth.authformentrystore.md) > [onAutofillForm](./foundation-auth.authformentrystore.onautofillform.md)
|
|
4
|
+
|
|
5
|
+
## AuthFormEntryStore.onAutofillForm() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
onAutofillForm(event: CustomEvent<void>): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| event | CustomEvent<void> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -21,8 +21,8 @@ Transient state during the machine's execution.
|
|
|
21
21
|
|
|
22
22
|
| Property | Modifiers | Type | Description |
|
|
23
23
|
| --- | --- | --- | --- |
|
|
24
|
-
| [authDTO](./foundation-auth.authmachinecontext.authdto.md) | | [AuthDTO](./foundation-auth.authdto.md) | The login/login
|
|
25
|
-
| [authEntity](./foundation-auth.authmachinecontext.authentity.md) | | [AuthEntity](./foundation-auth.authentity.md) | The login/login
|
|
24
|
+
| [authDTO](./foundation-auth.authmachinecontext.authdto.md) | | [AuthDTO](./foundation-auth.authdto.md) | The login/login DTO from the fetch machine. |
|
|
25
|
+
| [authEntity](./foundation-auth.authmachinecontext.authentity.md) | | [AuthEntity](./foundation-auth.authentity.md) | The login/login Entity mapped from the DTO. |
|
|
26
26
|
| [credentials?](./foundation-auth.authmachinecontext.credentials.md) | | AuthInfo | _(Optional)_ The authentication credentials. |
|
|
27
27
|
| [mapper](./foundation-auth.authmachinecontext.mapper.md) | | [Mapper](./foundation-auth.mapper.md)<!-- --><[AuthDTO](./foundation-auth.authdto.md)<!-- -->, [AuthEntity](./foundation-auth.authentity.md)<!-- -->> | The mapper for the action being taken. |
|
|
28
28
|
| [user](./foundation-auth.authmachinecontext.user.md) | | [User](./foundation-auth.user.md) | The user, either authenticated or anonymous. |
|
|
@@ -30,6 +30,7 @@ This is the root store for the foundation-auth package.
|
|
|
30
30
|
| Method | Description |
|
|
31
31
|
| --- | --- |
|
|
32
32
|
| [onLogin(event)](./foundation-auth.authstore.onlogin.md) | |
|
|
33
|
+
| [onLoginDetails(event)](./foundation-auth.authstore.onlogindetails.md) | |
|
|
33
34
|
| [onLogout(event)](./foundation-auth.authstore.onlogout.md) | |
|
|
34
35
|
| [onMachineEvent(event)](./foundation-auth.authstore.onmachineevent.md) | |
|
|
35
36
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [AuthStore](./foundation-auth.authstore.md) > [onLoginDetails](./foundation-auth.authstore.onlogindetails.md)
|
|
4
|
+
|
|
5
|
+
## AuthStore.onLoginDetails() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
onLoginDetails(event: CustomEvent<void>): void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| event | CustomEvent<void> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
void
|
|
22
|
+
|
|
@@ -34,6 +34,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
34
34
|
| [idps](./foundation-auth.defaultauthformentrystore.idps.md) | | [IDP](./foundation-auth.idp.md)<!-- -->\[\] | |
|
|
35
35
|
| [message](./foundation-auth.defaultauthformentrystore.message.md) | | string | |
|
|
36
36
|
| [mfaCode](./foundation-auth.defaultauthformentrystore.mfacode.md) | | string | |
|
|
37
|
+
| [onAutofillForm](./foundation-auth.defaultauthformentrystore.onautofillform.md) | | EventListener | |
|
|
37
38
|
| [onEmailChanged](./foundation-auth.defaultauthformentrystore.onemailchanged.md) | | EventListener | |
|
|
38
39
|
| [onOrganisationChanged](./foundation-auth.defaultauthformentrystore.onorganisationchanged.md) | | EventListener | |
|
|
39
40
|
| [onPassword2Changed](./foundation-auth.defaultauthformentrystore.onpassword2changed.md) | | EventListener | |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) > [onAutofillForm](./foundation-auth.defaultauthformentrystore.onautofillform.md)
|
|
4
|
+
|
|
5
|
+
## DefaultAuthFormEntryStore.onAutofillForm property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
onAutofillForm: EventListener;
|
|
11
|
+
```
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [DefaultAuthMachine](./foundation-auth.defaultauthmachine.md) > [addLoginEvents](./foundation-auth.defaultauthmachine.addloginevents.md)
|
|
4
|
+
|
|
5
|
+
## DefaultAuthMachine.addLoginEvents() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
addLoginEvents(): {
|
|
11
|
+
login: {
|
|
12
|
+
actions: string[];
|
|
13
|
+
target: string;
|
|
14
|
+
};
|
|
15
|
+
"login-details": {
|
|
16
|
+
target: string;
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
**Returns:**
|
|
21
|
+
|
|
22
|
+
{ login: { actions: string\[\]; target: string; }; "login-details": { target: string; }; }
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [DefaultAuthMachine](./foundation-auth.defaultauthmachine.md) > [createFetchMachineEvent](./foundation-auth.defaultauthmachine.createfetchmachineevent.md)
|
|
4
|
+
|
|
5
|
+
## DefaultAuthMachine.createFetchMachineEvent() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
createFetchMachineEvent(url: string, msg?: Message): FetchMachineEvent;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| url | string | |
|
|
18
|
+
| msg | Message | _(Optional)_ |
|
|
19
|
+
|
|
20
|
+
**Returns:**
|
|
21
|
+
|
|
22
|
+
FetchMachineEvent
|
|
23
|
+
|
|
@@ -25,6 +25,8 @@ export declare class DefaultAuthMachine extends AbstractMachine<AuthMachineConte
|
|
|
25
25
|
|
|
26
26
|
| Method | Modifiers | Description |
|
|
27
27
|
| --- | --- | --- |
|
|
28
|
+
| [addLoginEvents()](./foundation-auth.defaultauthmachine.addloginevents.md) | | |
|
|
29
|
+
| [createFetchMachineEvent(url, msg)](./foundation-auth.defaultauthmachine.createfetchmachineevent.md) | | |
|
|
28
30
|
| [getFromContainer()](./foundation-auth.defaultauthmachine.getfromcontainer.md) | | AuthMachine is a singleton. |
|
|
29
31
|
| [start(options)](./foundation-auth.defaultauthmachine.start.md) | | |
|
|
30
32
|
|
|
@@ -30,6 +30,7 @@ export declare class DefaultAuthStore extends AbstractStoreRoot<AuthStore, AuthE
|
|
|
30
30
|
| [formEntry](./foundation-auth.defaultauthstore.formentry.md) | <code>readonly</code> | [AuthFormEntryStore](./foundation-auth.authformentrystore.md) | |
|
|
31
31
|
| [isPending](./foundation-auth.defaultauthstore.ispending.md) | <code>readonly</code> | boolean | |
|
|
32
32
|
| [onLogin](./foundation-auth.defaultauthstore.onlogin.md) | | EventListener | |
|
|
33
|
+
| [onLoginDetails](./foundation-auth.defaultauthstore.onlogindetails.md) | | EventListener | |
|
|
33
34
|
| [onLogout](./foundation-auth.defaultauthstore.onlogout.md) | | EventListener | |
|
|
34
35
|
| [onMachineEvent](./foundation-auth.defaultauthstore.onmachineevent.md) | | EventListener | |
|
|
35
36
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [DefaultAuthStore](./foundation-auth.defaultauthstore.md) > [onLoginDetails](./foundation-auth.defaultauthstore.onlogindetails.md)
|
|
4
|
+
|
|
5
|
+
## DefaultAuthStore.onLoginDetails property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
onLoginDetails: EventListener;
|
|
11
|
+
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [EVENT\_LOGIN\_DETAILS\_ACK](./foundation-auth.event_login_details_ack.md)
|
|
4
|
+
|
|
5
|
+
## EVENT\_LOGIN\_DETAILS\_ACK interface
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export interface EVENT_LOGIN_DETAILS_ACK extends EVENT_LOGIN_AUTH_ACK
|
|
12
|
+
```
|
|
13
|
+
**Extends:** [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md)
|
|
14
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [isLoginDetailsAckDTO](./foundation-auth.islogindetailsackdto.md)
|
|
4
|
+
|
|
5
|
+
## isLoginDetailsAckDTO() function
|
|
6
|
+
|
|
7
|
+
isLoginDetailsAckDTO.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function isLoginDetailsAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_DETAILS_ACK;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| dto | [LoginDTO](./foundation-auth.logindto.md) | Potential DTO. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
dto is [EVENT\_LOGIN\_DETAILS\_ACK](./foundation-auth.event_login_details_ack.md)
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [isLoginDetailsAckEntity](./foundation-auth.islogindetailsackentity.md)
|
|
4
|
+
|
|
5
|
+
## isLoginDetailsAckEntity() function
|
|
6
|
+
|
|
7
|
+
isLoginDetailsAckEntity.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function isLoginDetailsAckEntity(entity: LoginEntity): entity is LoginDetailsAck;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| entity | [LoginEntity](./foundation-auth.loginentity.md) | Potential entity. |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
entity is [LoginDetailsAck](./foundation-auth.logindetailsack.md)
|
|
24
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-auth](./foundation-auth.md) > [LoginDetailsAck](./foundation-auth.logindetailsack.md)
|
|
4
|
+
|
|
5
|
+
## LoginDetailsAck interface
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export interface LoginDetailsAck extends LoginAck
|
|
12
|
+
```
|
|
13
|
+
**Extends:** [LoginAck](./foundation-auth.loginack.md)
|
|
14
|
+
|