@aws-amplify/auth 4.5.10 → 4.5.11-next.2

package/lib-esm/types/Auth.d.ts

@@ -12,6 +12,7 @@ export interface SignUpParams {
     clientMetadata?: {
         [key: string]: string;
     };
+    autoSignIn?: AutoSignInOptions;
 }
 export interface AuthCache {
     setItem(): any;
@@ -35,6 +36,7 @@ export interface AuthOptions {
     identityPoolRegion?: string;
     clientMetadata?: any;
     endpoint?: string;
+    signUpVerificationMethod?: 'code' | 'link';
 }
 export declare enum CognitoHostedUIIdentityProvider {
     Cognito = "COGNITO",
@@ -133,7 +135,8 @@ export declare enum AuthErrorTypes {
     NoUserSession = "noUserSession",
     Default = "default",
     DeviceConfig = "deviceConfig",
-    NetworkError = "networkError"
+    NetworkError = "networkError",
+    AutoSignInError = "autoSignInError"
 }
 export declare type AuthErrorMessages = {
     [key in AuthErrorTypes]: AuthErrorMessage;
@@ -151,6 +154,13 @@ export interface IAuthDevice {
     id: string;
     name: string;
 }
+export interface AutoSignInOptions {
+    enabled: boolean;
+    clientMetaData?: ClientMetaData;
+    validationData?: {
+        [key: string]: any;
+    };
+}
 export declare enum GRAPHQL_AUTH_MODE {
     API_KEY = "API_KEY",
     AWS_IAM = "AWS_IAM",

package/lib-esm/types/Auth.js

@@ -49,6 +49,7 @@ export var AuthErrorTypes;
     AuthErrorTypes["Default"] = "default";
     AuthErrorTypes["DeviceConfig"] = "deviceConfig";
     AuthErrorTypes["NetworkError"] = "networkError";
+    AuthErrorTypes["AutoSignInError"] = "autoSignInError";
 })(AuthErrorTypes || (AuthErrorTypes = {}));
 export function isUsernamePasswordOpts(obj) {
     return !!obj.username;

package/lib-esm/types/Auth.js.map

@@ -1 +1 @@
-{"version":3,"file":"Auth.js","sourceRoot":"","sources":["../../src/types/Auth.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AA2CH,MAAM,CAAN,IAAY,+BAMX;AAND,WAAY,+BAA+B;IAC1C,sDAAmB,CAAA;IACnB,oDAAiB,CAAA;IACjB,wDAAqB,CAAA;IACrB,6DAA0B,CAAA;IAC1B,4DAAyB,CAAA;AAC1B,CAAC,EANW,+BAA+B,KAA/B,+BAA+B,QAM1C;AAmBD,MAAM,UAAU,wBAAwB,CACvC,GAAQ;IAER,IAAM,IAAI,GAAqC,CAAC,UAAU,CAAC,CAAC;IAC5D,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC7C,GAAQ;IAER,IAAM,IAAI,GAA2C,CAAC,gBAAgB,CAAC,CAAC;IACxE,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAQ;IACtC,IAAM,IAAI,GAGH,CAAC,aAAa,CAAC,CAAC;IACvB,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;AACvD,CAAC;AAyCD,MAAM,UAAU,mBAAmB,CAClC,KAAgB;IAEhB,OAA6B,KAAM,CAAC,cAAc,KAAK,SAAS,CAAC;AAClE,CAAC;AA4CD,MAAM,CAAN,IAAY,cAeX;AAfD,WAAY,cAAc;IACzB,uCAAqB,CAAA;IACrB,yDAAuC,CAAA;IACvC,iDAA+B,CAAA;IAC/B,qDAAmC,CAAA;IACnC,iDAA+B,CAAA;IAC/B,yCAAuB,CAAA;IACvB,6CAA2B,CAAA;IAC3B,iCAAe,CAAA;IACf,2CAAyB,CAAA;IACzB,mEAAiD,CAAA;IACjD,iDAA+B,CAAA;IAC/B,qCAAmB,CAAA;IACnB,+CAA6B,CAAA;IAC7B,+CAA6B,CAAA;AAC9B,CAAC,EAfW,cAAc,KAAd,cAAc,QAezB;AAkBD,MAAM,UAAU,sBAAsB,CAAC,GAAQ;IAC9C,OAAO,CAAC,CAAE,GAA4B,CAAC,QAAQ,CAAC;AACjD,CAAC;AAOD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC5B,wCAAmB,CAAA;IACnB,wCAAmB,CAAA;IACnB,sDAAiC,CAAA;IACjC,4EAAuD,CAAA;IACvD,8CAAyB,CAAA;AAC1B,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B"}
+{"version":3,"file":"Auth.js","sourceRoot":"","sources":["../../src/types/Auth.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AA6CH,MAAM,CAAN,IAAY,+BAMX;AAND,WAAY,+BAA+B;IAC1C,sDAAmB,CAAA;IACnB,oDAAiB,CAAA;IACjB,wDAAqB,CAAA;IACrB,6DAA0B,CAAA;IAC1B,4DAAyB,CAAA;AAC1B,CAAC,EANW,+BAA+B,KAA/B,+BAA+B,QAM1C;AAmBD,MAAM,UAAU,wBAAwB,CACvC,GAAQ;IAER,IAAM,IAAI,GAAqC,CAAC,UAAU,CAAC,CAAC;IAC5D,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,8BAA8B,CAC7C,GAAQ;IAER,IAAM,IAAI,GAA2C,CAAC,gBAAgB,CAAC,CAAC;IACxE,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAQ;IACtC,IAAM,IAAI,GAGH,CAAC,aAAa,CAAC,CAAC;IACvB,OAAO,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAArB,CAAqB,CAAC,CAAC;AACvD,CAAC;AAyCD,MAAM,UAAU,mBAAmB,CAClC,KAAgB;IAEhB,OAA6B,KAAM,CAAC,cAAc,KAAK,SAAS,CAAC;AAClE,CAAC;AA4CD,MAAM,CAAN,IAAY,cAgBX;AAhBD,WAAY,cAAc;IACzB,uCAAqB,CAAA;IACrB,yDAAuC,CAAA;IACvC,iDAA+B,CAAA;IAC/B,qDAAmC,CAAA;IACnC,iDAA+B,CAAA;IAC/B,yCAAuB,CAAA;IACvB,6CAA2B,CAAA;IAC3B,iCAAe,CAAA;IACf,2CAAyB,CAAA;IACzB,mEAAiD,CAAA;IACjD,iDAA+B,CAAA;IAC/B,qCAAmB,CAAA;IACnB,+CAA6B,CAAA;IAC7B,+CAA6B,CAAA;IAC7B,qDAAmC,CAAA;AACpC,CAAC,EAhBW,cAAc,KAAd,cAAc,QAgBzB;AAkBD,MAAM,UAAU,sBAAsB,CAAC,GAAQ;IAC9C,OAAO,CAAC,CAAE,GAA4B,CAAC,QAAQ,CAAC;AACjD,CAAC;AAaD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC5B,wCAAmB,CAAA;IACnB,wCAAmB,CAAA;IACnB,sDAAiC,CAAA;IACjC,4EAAuD,CAAA;IACvD,8CAAyB,CAAA;AAC1B,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/auth",
-  "version": "4.5.10",
+  "version": "4.5.11-next.2+fd653f89d",
   "description": "Auth category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -41,9 +41,9 @@
   },
   "homepage": "https://aws-amplify.github.io/",
   "dependencies": {
-    "@aws-amplify/cache": "4.0.48",
-    "@aws-amplify/core": "4.5.10",
-    "amazon-cognito-identity-js": "5.2.10",
+    "@aws-amplify/cache": "4.0.49-next.2+fd653f89d",
+    "@aws-amplify/core": "4.5.11-next.2+fd653f89d",
+    "amazon-cognito-identity-js": "5.2.11-next.12+fd653f89d",
     "crypto-js": "^4.1.1"
   },
   "devDependencies": {
@@ -95,5 +95,5 @@
     ],
     "testSequencer": "./testSequencer.js"
   },
-  "gitHead": "e20a1468ebed5b62512e7bdbfc2d2c185a60f9c7"
+  "gitHead": "fd653f89d50f84778794f911a7606e63eb4f81f7"
 }

package/src/Auth.ts

@@ -44,6 +44,7 @@ import {
 	browserOrNode,
 	UniversalStorage,
 	urlSafeDecode,
+	HubCallback,
 } from '@aws-amplify/core';
 import {
 	CookieStorage,
@@ -70,6 +71,7 @@ import { default as urlListener } from './urlListener';
 import { AuthError, NoUserPoolError } from './Errors';
 import {
 	AuthErrorTypes,
+	AutoSignInOptions,
 	CognitoHostedUIIdentityProvider,
 	IAuthDevice,
 } from './types/Auth';
@@ -95,6 +97,8 @@ const dispatchAuthEvent = (event: string, data: any, message: string) => {
 // https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListDevices.html#API_ListDevices_RequestSyntax
 const MAX_DEVICES = 60;
 
+const MAX_AUTOSIGNIN_POLLING_MS = 3 * 60 * 1000;
+
 /**
  * Provide authentication steps
  */
@@ -107,6 +111,7 @@ export class AuthClass {
 	private _storageSync;
 	private oAuthFlowInProgress: boolean = false;
 	private pendingSignIn: ReturnType<AuthClass['signInWithPassword']> | null;
+	private autoSignInInitiated: boolean = false;
 
 	Credentials = Credentials;
 
@@ -257,6 +262,24 @@ export class AuthClass {
 			null,
 			`The Auth category has been configured successfully`
 		);
+
+		if (
+			!this.autoSignInInitiated &&
+			typeof this._storage['getItem'] === 'function'
+		) {
+			const pollingInitiated = this.isTrueStorageValue(
+				'amplify-polling-started'
+			);
+			if (pollingInitiated) {
+				dispatchAuthEvent(
+					'autoSignIn_failure',
+					null,
+					AuthErrorTypes.AutoSignInError
+				);
+				this._storage.removeItem('amplify-auto-sign-in');
+			}
+			this._storage.removeItem('amplify-polling-started');
+		}
 		return this._config;
 	}
 
@@ -295,6 +318,9 @@ export class AuthClass {
 		const attributes: CognitoUserAttribute[] = [];
 		let validationData: CognitoUserAttribute[] = null;
 		let clientMetadata;
+		let autoSignIn: AutoSignInOptions = { enabled: false };
+		let autoSignInValidationData = {};
+		let autoSignInClientMetaData: ClientMetaData = {};
 
 		if (params && typeof params === 'string') {
 			username = params;
@@ -345,6 +371,13 @@ export class AuthClass {
 					);
 				});
 			}
+
+			autoSignIn = params.autoSignIn ?? { enabled: false };
+			if (autoSignIn.enabled) {
+				this._storage.setItem('amplify-auto-sign-in', 'true');
+				autoSignInValidationData = autoSignIn.validationData ?? {};
+				autoSignInClientMetaData = autoSignIn.clientMetaData ?? {};
+			}
 		} else {
 			return this.rejectAuthError(AuthErrorTypes.SignUpError);
 		}
@@ -379,6 +412,15 @@ export class AuthClass {
 							data,
 							`${username} has signed up successfully`
 						);
+						if (autoSignIn.enabled) {
+							this.handleAutoSignIn(
+								username,
+								password,
+								autoSignInValidationData,
+								autoSignInClientMetaData,
+								data
+							);
+						}
 						resolve(data);
 					}
 				},
@@ -387,6 +429,97 @@ export class AuthClass {
 		});
 	}
 
+	private handleAutoSignIn(
+		username: string,
+		password: string,
+		validationData: {},
+		clientMetadata: any,
+		data: any
+	) {
+		this.autoSignInInitiated = true;
+		const authDetails = new AuthenticationDetails({
+			Username: username,
+			Password: password,
+			ValidationData: validationData,
+			ClientMetadata: clientMetadata,
+		});
+		if (data.userConfirmed) {
+			this.signInAfterUserConfirmed(authDetails);
+		} else if (this._config.signUpVerificationMethod === 'link') {
+			this.handleLinkAutoSignIn(authDetails);
+		} else {
+			this.handleCodeAutoSignIn(authDetails);
+		}
+	}
+
+	private handleCodeAutoSignIn(authDetails: AuthenticationDetails) {
+		const listenEvent = ({ payload }) => {
+			if (payload.event === 'confirmSignUp') {
+				this.signInAfterUserConfirmed(authDetails, listenEvent);
+			}
+		};
+		Hub.listen('auth', listenEvent);
+	}
+
+	private handleLinkAutoSignIn(authDetails: AuthenticationDetails) {
+		this._storage.setItem('amplify-polling-started', 'true');
+		const start = Date.now();
+		const autoSignInPollingIntervalId = setInterval(() => {
+			if (Date.now() - start > MAX_AUTOSIGNIN_POLLING_MS) {
+				clearInterval(autoSignInPollingIntervalId);
+				dispatchAuthEvent(
+					'autoSignIn_failure',
+					null,
+					'Please confirm your account and use your credentials to sign in.'
+				);
+				this._storage.removeItem('amplify-auto-sign-in');
+			} else {
+				this.signInAfterUserConfirmed(
+					authDetails,
+					null,
+					autoSignInPollingIntervalId
+				);
+			}
+		}, 5000);
+	}
+
+	private async signInAfterUserConfirmed(
+		authDetails: AuthenticationDetails,
+		listenEvent?: HubCallback,
+		autoSignInPollingIntervalId?: ReturnType<typeof setInterval>
+	) {
+		const user = this.createCognitoUser(authDetails.getUsername());
+		try {
+			await user.authenticateUser(
+				authDetails,
+				this.authCallbacks(
+					user,
+					value => {
+						dispatchAuthEvent(
+							'autoSignIn',
+							value,
+							`${authDetails.getUsername()} has signed in successfully`
+						);
+						if (listenEvent) {
+							Hub.remove('auth', listenEvent);
+						}
+						if (autoSignInPollingIntervalId) {
+							clearInterval(autoSignInPollingIntervalId);
+							this._storage.removeItem('amplify-polling-started');
+						}
+						this._storage.removeItem('amplify-auto-sign-in');
+					},
+					error => {
+						logger.error(error);
+						this._storage.removeItem('amplify-auto-sign-in');
+					}
+				)
+			);
+		} catch (error) {
+			logger.error(error);
+		}
+	}
+
 	/**
 	 * Send the verification code to confirm sign up
 	 * @param {String} username - The username to be confirmed
@@ -429,6 +562,20 @@ export class AuthClass {
 					if (err) {
 						reject(err);
 					} else {
+						dispatchAuthEvent(
+							'confirmSignUp',
+							data,
+							`${username} has been confirmed successfully`
+						);
+						const autoSignIn = this.isTrueStorageValue('amplify-auto-sign-in');
+						if (autoSignIn && !this.autoSignInInitiated) {
+							dispatchAuthEvent(
+								'autoSignIn_failure',
+								null,
+								AuthErrorTypes.AutoSignInError
+							);
+							this._storage.removeItem('amplify-auto-sign-in');
+						}
 						resolve(data);
 					}
 				},
@@ -437,6 +584,11 @@ export class AuthClass {
 		});
 	}
 
+	private isTrueStorageValue(value: string) {
+		const item = this._storage.getItem(value);
+		return item ? item === 'true' : false;
+	}
+
 	/**
 	 * Resend the verification code
 	 * @param {String} username - The username to be confirmed
@@ -1636,7 +1788,7 @@ export class AuthClass {
 		logger.debug('Getting current session');
 		// Purposely not calling the reject method here because we don't need a console error
 		if (!this.userPool) {
-			return this.rejectNoUserPool();
+			return Promise.reject(new Error('No User Pool in the configuration.'));
 		}
 
 		return new Promise((res, rej) => {

package/src/Errors.ts

@@ -110,6 +110,9 @@ export const authErrorMessages: AuthErrorMessages = {
 	networkError: {
 		message: AuthErrorStrings.NETWORK_ERROR,
 	},
+	autoSignInError: {
+		message: AuthErrorStrings.AUTOSIGNIN_ERROR,
+	},
 	default: {
 		message: AuthErrorStrings.DEFAULT_MSG,
 	},

package/src/common/AuthErrorStrings.ts

@@ -13,4 +13,5 @@ export enum AuthErrorStrings {
 	NO_USER_SESSION = 'Failed to get the session because the user is empty',
 	NETWORK_ERROR = 'Network Error',
 	DEVICE_CONFIG = 'Device tracking has not been configured in this User Pool',
+	AUTOSIGNIN_ERROR = 'Please use your credentials to sign in',
 }

package/src/types/Auth.ts

@@ -25,6 +25,7 @@ export interface SignUpParams {
 	attributes?: object;
 	validationData?: { [key: string]: any };
 	clientMetadata?: { [key: string]: string };
+	autoSignIn?: AutoSignInOptions;
 }
 
 export interface AuthCache {
@@ -50,6 +51,7 @@ export interface AuthOptions {
 	identityPoolRegion?: string;
 	clientMetadata?: any;
 	endpoint?: string;
+	signUpVerificationMethod?: 'code' | 'link';
 }
 
 export enum CognitoHostedUIIdentityProvider {
@@ -201,6 +203,7 @@ export enum AuthErrorTypes {
 	Default = 'default',
 	DeviceConfig = 'deviceConfig',
 	NetworkError = 'networkError',
+	AutoSignInError = 'autoSignInError',
 }
 
 export type AuthErrorMessages = { [key in AuthErrorTypes]: AuthErrorMessage };
@@ -228,6 +231,12 @@ export interface IAuthDevice {
 	name: string;
 }
 
+export interface AutoSignInOptions {
+	enabled: boolean;
+	clientMetaData?: ClientMetaData;
+	validationData?: { [key: string]: any };
+}
+
 export enum GRAPHQL_AUTH_MODE {
 	API_KEY = 'API_KEY',
 	AWS_IAM = 'AWS_IAM',