Changes based on PR review

zegates · Aug 23, 2019 · 6048436 · 6048436
1 parent 6494cdd
commit 6048436
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/packages/auth/__tests__/auth-unit-test.ts b/packages/auth/__tests__/auth-unit-test.ts
@@ -854,11 +854,11 @@ describe('auth unit test', () => {
                 Pool: userPool
             });
 
-            const error = new AuthError(AuthErrorTypes.EmptyPassword);
+            const errorMessage = new AuthError(AuthErrorTypes.EmptyPassword);
 
             expect.assertions(2);
             await expect(auth.completeNewPassword(user, null, {}).then()).rejects.toThrow(AuthError);
-            await expect(auth.completeNewPassword(user, null, {}).then()).rejects.toEqual(error);
+            await expect(auth.completeNewPassword(user, null, {}).then()).rejects.toEqual(errorMessage);
         });
     });
 
@@ -1303,11 +1303,11 @@ describe('auth unit test', () => {
                 Username: 'username',
                 Pool: userPool
             });
-            const error = new AuthError(AuthErrorTypes.EmptyCode);
+            const errorMessage = new AuthError(AuthErrorTypes.EmptyCode);
 
             expect.assertions(2);
             expect(auth.verifyUserAttributeSubmit(user, {}, null).then()).rejects.toThrow(AuthError);
-            expect(auth.verifyUserAttributeSubmit(user, {}, null).then()).rejects.toEqual(error);
+            expect(auth.verifyUserAttributeSubmit(user, {}, null).then()).rejects.toEqual(errorMessage);
         });
     });
 

diff --git a/packages/auth/src/Errors.ts b/packages/auth/src/Errors.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Copyright 2019-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
  * the License. A copy of the License is located at
@@ -54,7 +54,7 @@ export const authErrorMessages: AuthErrorMessages = {
         log: `
             Error: Amplify has not been configured correctly.
             This error is typically caused by one of the following scenarios:
-            
+
             1. Make sure you're passing the awsconfig object to Amplify.configure() in your app's entry point
                 See https://aws-amplify.github.io/docs/js/authentication#configure-your-app for more information
             
@@ -74,6 +74,7 @@ export const authErrorMessages: AuthErrorMessages = {
     emptyUsername: {
         message: 'Username cannot be empty'
     },
+    // TODO: should include a list of valid sign-in types
     invalidUsername: {
         message:
             'The username should either be a string or one of the sign in types'

diff --git a/packages/auth/src/types/Auth.ts b/packages/auth/src/types/Auth.ts
@@ -191,7 +191,7 @@ export enum AuthErrorTypes {
     Default = 'default'
 }
 
-export type AuthErrorMessages = { [key in AuthErrorTypes]?: AuthErrorMessage };
+export type AuthErrorMessages = { [key in AuthErrorTypes]: AuthErrorMessage };
 
 export interface AuthErrorMessage {
     message: string;