@genesislcap/foundation-auth 14.71.1-auth-mf.2 → 14.71.1-auth-mf.4
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 +6 -15
- 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 +6 -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 -30
- package/dist/esm/routes/config.js +0 -2
- package/dist/esm/routes/login/login.js +46 -63
- package/dist/esm/routes/login/login.template.js +4 -5
- package/dist/esm/store/auth.js +1 -0
- package/dist/esm/store/authFormEntry.js +39 -27
- package/dist/foundation-auth.api.json +648 -45
- package/dist/foundation-auth.d.ts +67 -26
- 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 +2 -0
- package/docs/api/foundation-auth.authformentrystore.onautofillform.md +22 -0
- package/docs/api/foundation-auth.authformentrystore.orgusername.md +11 -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._constructor_.md +13 -0
- package/docs/api/foundation-auth.defaultauthformentrystore.md +8 -0
- package/docs/api/foundation-auth.defaultauthformentrystore.onautofillform.md +11 -0
- package/docs/api/foundation-auth.defaultauthformentrystore.orgusername.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 +59 -13
- 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;
|
|
@@ -638,6 +650,7 @@ export declare interface AuthFormEntryStore extends Store {
|
|
|
638
650
|
readonly host: string;
|
|
639
651
|
readonly organisation: string;
|
|
640
652
|
readonly username: string;
|
|
653
|
+
readonly orgUsername: string;
|
|
641
654
|
readonly email: string;
|
|
642
655
|
readonly password: string;
|
|
643
656
|
readonly password2: string;
|
|
@@ -657,6 +670,7 @@ export declare interface AuthFormEntryStore extends Store {
|
|
|
657
670
|
onPasswordChanged(event: CustomEvent<string>): void;
|
|
658
671
|
onPassword2Changed(event: CustomEvent<string>): void;
|
|
659
672
|
onShowPasswordsChanged(event: CustomEvent<boolean>): void;
|
|
673
|
+
onAutofillForm(event: CustomEvent<void>): void;
|
|
660
674
|
}
|
|
661
675
|
|
|
662
676
|
/**
|
|
@@ -698,15 +712,15 @@ export declare interface AuthMachineContext extends MachineContext {
|
|
|
698
712
|
/**
|
|
699
713
|
* The authentication credentials.
|
|
700
714
|
* @remarks
|
|
701
|
-
*
|
|
715
|
+
* Optional as it's possible to reauthenticate silently.
|
|
702
716
|
*/
|
|
703
717
|
credentials?: AuthInfo;
|
|
704
718
|
/**
|
|
705
|
-
* The login/login
|
|
719
|
+
* The login/login DTO from the fetch machine.
|
|
706
720
|
*/
|
|
707
721
|
authDTO: AuthDTO;
|
|
708
722
|
/**
|
|
709
|
-
* The login/login
|
|
723
|
+
* The login/login Entity mapped from the DTO.
|
|
710
724
|
*/
|
|
711
725
|
authEntity: AuthEntity;
|
|
712
726
|
/**
|
|
@@ -730,8 +744,6 @@ export declare type AuthMachineEvent = {
|
|
|
730
744
|
params: {
|
|
731
745
|
credentials?: AuthInfo;
|
|
732
746
|
};
|
|
733
|
-
} | {
|
|
734
|
-
type: 'refresh';
|
|
735
747
|
} | {
|
|
736
748
|
type: 'logout';
|
|
737
749
|
} | {
|
|
@@ -770,6 +782,7 @@ export declare interface AuthStore extends StoreRoot {
|
|
|
770
782
|
*/
|
|
771
783
|
onMachineEvent(event: CustomEvent<AuthEventMap['auth-machine-event']>): void;
|
|
772
784
|
onLogin(event: CustomEvent<AuthInfo>): void;
|
|
785
|
+
onLoginDetails(event: CustomEvent<void>): void;
|
|
773
786
|
onLogout(event: CustomEvent<void>): void;
|
|
774
787
|
}
|
|
775
788
|
|
|
@@ -815,7 +828,9 @@ export declare class BaseRoute extends ConfigHostElement {
|
|
|
815
828
|
message: string;
|
|
816
829
|
hasErrors: boolean;
|
|
817
830
|
isSubmitting: boolean;
|
|
831
|
+
protected navigationPhase: NavigationPhase<Settings>;
|
|
818
832
|
connectedCallback(): void;
|
|
833
|
+
enter(phase: NavigationPhase<Settings>): void;
|
|
819
834
|
onSubmit(): Promise<void>;
|
|
820
835
|
ensureConnection(): Promise<boolean>;
|
|
821
836
|
setError(message: string): void;
|
|
@@ -849,7 +864,7 @@ export declare class ConfigHostElement extends ConfigHostElement_base implements
|
|
|
849
864
|
}
|
|
850
865
|
|
|
851
866
|
declare const ConfigHostElement_base: abstract new (...args: any[]) => {
|
|
852
|
-
$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-
|
|
867
|
+
$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;
|
|
853
868
|
accessKey: string;
|
|
854
869
|
readonly accessKeyLabel: string;
|
|
855
870
|
autocapitalize: string;
|
|
@@ -934,13 +949,7 @@ declare const ConfigHostElement_base: abstract new (...args: any[]) => {
|
|
|
934
949
|
scrollBy(options?: ScrollToOptions): void;
|
|
935
950
|
scrollBy(x: number, y: number): void;
|
|
936
951
|
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
937
|
-
/**
|
|
938
|
-
* @internal
|
|
939
|
-
*/
|
|
940
952
|
scrollTo(options?: ScrollToOptions): void;
|
|
941
|
-
/**
|
|
942
|
-
* @internal
|
|
943
|
-
*/
|
|
944
953
|
scrollTo(x: number, y: number): void;
|
|
945
954
|
setAttribute(qualifiedName: string, value: string): void;
|
|
946
955
|
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
@@ -1170,14 +1179,6 @@ declare const ConfigHostElement_base: abstract new (...args: any[]) => {
|
|
|
1170
1179
|
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
1171
1180
|
};
|
|
1172
1181
|
|
|
1173
|
-
/**
|
|
1174
|
-
* @internal
|
|
1175
|
-
* @privateRemarks
|
|
1176
|
-
* Potential optimisation ahead of workflow / statemachine based smart forms integration, but needs tagFor.
|
|
1177
|
-
* Feels a bit at odds with the declarative nature we're aiming for, but will await review.
|
|
1178
|
-
*/
|
|
1179
|
-
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>;
|
|
1180
|
-
|
|
1181
1182
|
/**
|
|
1182
1183
|
* Configure the auth micro frontend settings.
|
|
1183
1184
|
*
|
|
@@ -1258,6 +1259,8 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
1258
1259
|
selectedIDP: string;
|
|
1259
1260
|
ssoToggled: boolean;
|
|
1260
1261
|
termsAgreed: boolean;
|
|
1262
|
+
get orgUsername(): string;
|
|
1263
|
+
constructor();
|
|
1261
1264
|
private autofill;
|
|
1262
1265
|
onOrganisationChanged: EventListener;
|
|
1263
1266
|
onUsernameChanged: EventListener;
|
|
@@ -1265,6 +1268,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
1265
1268
|
onPasswordChanged: EventListener;
|
|
1266
1269
|
onPassword2Changed: EventListener;
|
|
1267
1270
|
onShowPasswordsChanged: EventListener;
|
|
1271
|
+
onAutofillForm: EventListener;
|
|
1268
1272
|
}
|
|
1269
1273
|
|
|
1270
1274
|
/**
|
|
@@ -1287,6 +1291,16 @@ export declare class DefaultAuthMachine extends AbstractMachine<AuthMachineConte
|
|
|
1287
1291
|
* AuthMachine is a singleton.
|
|
1288
1292
|
*/
|
|
1289
1293
|
getFromContainer(): this;
|
|
1294
|
+
createFetchMachineEvent(url: string, msg?: Message_2): FetchMachineEvent;
|
|
1295
|
+
addLoginEvents(): {
|
|
1296
|
+
login: {
|
|
1297
|
+
actions: string[];
|
|
1298
|
+
target: string;
|
|
1299
|
+
};
|
|
1300
|
+
"login-details": {
|
|
1301
|
+
target: string;
|
|
1302
|
+
};
|
|
1303
|
+
};
|
|
1290
1304
|
}
|
|
1291
1305
|
|
|
1292
1306
|
/**
|
|
@@ -1307,6 +1321,7 @@ export declare class DefaultAuthStore extends AbstractStoreRoot<AuthStore, AuthE
|
|
|
1307
1321
|
get isPending(): boolean;
|
|
1308
1322
|
onMachineEvent: EventListener;
|
|
1309
1323
|
onLogin: EventListener;
|
|
1324
|
+
onLoginDetails: EventListener;
|
|
1310
1325
|
onLogout: EventListener;
|
|
1311
1326
|
}
|
|
1312
1327
|
|
|
@@ -1514,6 +1529,12 @@ export declare interface EVENT_LOGIN_AUTH_ACK extends ACK {
|
|
|
1514
1529
|
export declare interface EVENT_LOGIN_AUTH_NACK extends NACK {
|
|
1515
1530
|
}
|
|
1516
1531
|
|
|
1532
|
+
/**
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
export declare interface EVENT_LOGIN_DETAILS_ACK extends EVENT_LOGIN_AUTH_ACK {
|
|
1536
|
+
}
|
|
1537
|
+
|
|
1517
1538
|
/**
|
|
1518
1539
|
* @public
|
|
1519
1540
|
*/
|
|
@@ -1670,6 +1691,20 @@ export declare function isLoginAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_AUTH_AC
|
|
|
1670
1691
|
*/
|
|
1671
1692
|
export declare function isLoginAckEntity(entity: LoginEntity): entity is LoginAck;
|
|
1672
1693
|
|
|
1694
|
+
/**
|
|
1695
|
+
* isLoginDetailsAckDTO.
|
|
1696
|
+
* @param dto - Potential DTO.
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
export declare function isLoginDetailsAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_DETAILS_ACK;
|
|
1700
|
+
|
|
1701
|
+
/**
|
|
1702
|
+
* isLoginDetailsAckEntity.
|
|
1703
|
+
* @param entity - Potential entity.
|
|
1704
|
+
* @public
|
|
1705
|
+
*/
|
|
1706
|
+
export declare function isLoginDetailsAckEntity(entity: LoginEntity): entity is LoginDetailsAck;
|
|
1707
|
+
|
|
1673
1708
|
/**
|
|
1674
1709
|
* isLoginNackDTO.
|
|
1675
1710
|
* @param dto - Potential DTO.
|
|
@@ -1763,17 +1798,23 @@ export declare interface LoginAck extends Ack {
|
|
|
1763
1798
|
readonly profile: string[];
|
|
1764
1799
|
}
|
|
1765
1800
|
|
|
1801
|
+
/**
|
|
1802
|
+
* @public
|
|
1803
|
+
*/
|
|
1804
|
+
export declare interface LoginDetailsAck extends LoginAck {
|
|
1805
|
+
}
|
|
1806
|
+
|
|
1766
1807
|
/**
|
|
1767
1808
|
* LoginDTO type.
|
|
1768
1809
|
* @public
|
|
1769
1810
|
*/
|
|
1770
|
-
export declare type LoginDTO = EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_AUTH_NACK;
|
|
1811
|
+
export declare type LoginDTO = EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_DETAILS_ACK | EVENT_LOGIN_AUTH_NACK;
|
|
1771
1812
|
|
|
1772
1813
|
/**
|
|
1773
1814
|
* LoginEntity type.
|
|
1774
1815
|
* @public
|
|
1775
1816
|
*/
|
|
1776
|
-
export declare type LoginEntity = LoginAck | LoginNack;
|
|
1817
|
+
export declare type LoginEntity = LoginAck | LoginDetailsAck | LoginNack;
|
|
1777
1818
|
|
|
1778
1819
|
/**
|
|
1779
1820
|
* 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
|
|
|
@@ -25,6 +25,7 @@ export interface AuthFormEntryStore extends Store
|
|
|
25
25
|
| [message](./foundation-auth.authformentrystore.message.md) | <code>readonly</code> | string | |
|
|
26
26
|
| [mfaCode](./foundation-auth.authformentrystore.mfacode.md) | <code>readonly</code> | string | |
|
|
27
27
|
| [organisation](./foundation-auth.authformentrystore.organisation.md) | <code>readonly</code> | string | |
|
|
28
|
+
| [orgUsername](./foundation-auth.authformentrystore.orgusername.md) | <code>readonly</code> | string | |
|
|
28
29
|
| [password](./foundation-auth.authformentrystore.password.md) | <code>readonly</code> | string | |
|
|
29
30
|
| [password2](./foundation-auth.authformentrystore.password2.md) | <code>readonly</code> | string | |
|
|
30
31
|
| [passwordResetToken](./foundation-auth.authformentrystore.passwordresettoken.md) | <code>readonly</code> | string | |
|
|
@@ -38,6 +39,7 @@ export interface AuthFormEntryStore extends Store
|
|
|
38
39
|
|
|
39
40
|
| Method | Description |
|
|
40
41
|
| --- | --- |
|
|
42
|
+
| [onAutofillForm(event)](./foundation-auth.authformentrystore.onautofillform.md) | |
|
|
41
43
|
| [onEmailChanged(event)](./foundation-auth.authformentrystore.onemailchanged.md) | |
|
|
42
44
|
| [onOrganisationChanged(event)](./foundation-auth.authformentrystore.onorganisationchanged.md) | |
|
|
43
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
|
+
|
|
@@ -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) > [AuthFormEntryStore](./foundation-auth.authformentrystore.md) > [orgUsername](./foundation-auth.authformentrystore.orgusername.md)
|
|
4
|
+
|
|
5
|
+
## AuthFormEntryStore.orgUsername property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly orgUsername: string;
|
|
11
|
+
```
|
|
@@ -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
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
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) > [(constructor)](./foundation-auth.defaultauthformentrystore._constructor_.md)
|
|
4
|
+
|
|
5
|
+
## DefaultAuthFormEntryStore.(constructor)
|
|
6
|
+
|
|
7
|
+
Constructs a new instance of the `DefaultAuthFormEntryStore` class
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
constructor();
|
|
13
|
+
```
|
|
@@ -15,6 +15,12 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
15
15
|
|
|
16
16
|
**Implements:** [AuthFormEntryStore](./foundation-auth.authformentrystore.md)
|
|
17
17
|
|
|
18
|
+
## Constructors
|
|
19
|
+
|
|
20
|
+
| Constructor | Modifiers | Description |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| [(constructor)()](./foundation-auth.defaultauthformentrystore._constructor_.md) | | Constructs a new instance of the <code>DefaultAuthFormEntryStore</code> class |
|
|
23
|
+
|
|
18
24
|
## Properties
|
|
19
25
|
|
|
20
26
|
| Property | Modifiers | Type | Description |
|
|
@@ -28,6 +34,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
28
34
|
| [idps](./foundation-auth.defaultauthformentrystore.idps.md) | | [IDP](./foundation-auth.idp.md)<!-- -->\[\] | |
|
|
29
35
|
| [message](./foundation-auth.defaultauthformentrystore.message.md) | | string | |
|
|
30
36
|
| [mfaCode](./foundation-auth.defaultauthformentrystore.mfacode.md) | | string | |
|
|
37
|
+
| [onAutofillForm](./foundation-auth.defaultauthformentrystore.onautofillform.md) | | EventListener | |
|
|
31
38
|
| [onEmailChanged](./foundation-auth.defaultauthformentrystore.onemailchanged.md) | | EventListener | |
|
|
32
39
|
| [onOrganisationChanged](./foundation-auth.defaultauthformentrystore.onorganisationchanged.md) | | EventListener | |
|
|
33
40
|
| [onPassword2Changed](./foundation-auth.defaultauthformentrystore.onpassword2changed.md) | | EventListener | |
|
|
@@ -35,6 +42,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
|
|
|
35
42
|
| [onShowPasswordsChanged](./foundation-auth.defaultauthformentrystore.onshowpasswordschanged.md) | | EventListener | |
|
|
36
43
|
| [onUsernameChanged](./foundation-auth.defaultauthformentrystore.onusernamechanged.md) | | EventListener | |
|
|
37
44
|
| [organisation](./foundation-auth.defaultauthformentrystore.organisation.md) | | string | |
|
|
45
|
+
| [orgUsername](./foundation-auth.defaultauthformentrystore.orgusername.md) | <code>readonly</code> | string | |
|
|
38
46
|
| [password](./foundation-auth.defaultauthformentrystore.password.md) | | string | |
|
|
39
47
|
| [password2](./foundation-auth.defaultauthformentrystore.password2.md) | | string | |
|
|
40
48
|
| [passwordResetToken](./foundation-auth.defaultauthformentrystore.passwordresettoken.md) | | string | |
|
|
@@ -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,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) > [orgUsername](./foundation-auth.defaultauthformentrystore.orgusername.md)
|
|
4
|
+
|
|
5
|
+
## DefaultAuthFormEntryStore.orgUsername property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
get orgUsername(): string;
|
|
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
|
+
```
|