fix(@aws-amplify/auth): define validationData type as object literal (#…

…8045) * fix(@aws-amplify/auth): redefine validationData as an object literal in SignUpParams type * chore(@aws-amplify/auth): fix linting errors for type-checking * test(@aws-amplify/auth): unit test for validationData * fix(@aws-amplify/auth): redefine validationData as an object literal in SignUpParams type * chore(@aws-amplify/auth): fix linting errors for type-checking * test(@aws-amplify/auth): unit test for validationData * test(@aws-amplify/auth): specify type of SignUpParams * test(@aws-amplify/auth): DIRTY - modify package.json to catch TS mismatches * fix(@aws-amplify/auth): redefine validationData as an object literal in SignUpParams type * chore(@aws-amplify/auth): fix linting errors for type-checking * test(@aws-amplify/auth): unit test for validationData * test(@aws-amplify/auth): specify type of SignUpParams * test(@aws-amplify/auth): DIRTY - modify package.json to catch TS mismatches * test(@aws-amplify/auth): modify happy case test to check Types correctly Co-authored-by: Nick Arocho <[email protected]> Co-authored-by: Ivan Artemiev <[email protected]>
aws-amplify · Apr 13, 2021 · 6d0b67c · 6d0b67c
1 parent c4ccc17
commit 6d0b67c
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 18 deletions.
diff --git a/packages/auth/__tests__/auth-unit-test.ts b/packages/auth/__tests__/auth-unit-test.ts
@@ -1,6 +1,14 @@
 import OAuth from '../src/OAuth/OAuth';
 import * as oauthStorage from '../src/OAuth/oauthStorage';
-import { NodeCallback } from 'amazon-cognito-identity-js';
+import {
+	CookieStorage,
+	CognitoUserPool,
+	CognitoUser,
+	CognitoUserSession,
+	CognitoIdToken,
+	CognitoAccessToken,
+	NodeCallback,
+} from 'amazon-cognito-identity-js';
 
 jest.mock('crypto-js/sha256', () => {
 	return {
@@ -222,14 +230,6 @@ jest.mock('amazon-cognito-identity-js/lib/CognitoUser', () => {
 import { AuthOptions, SignUpParams, AwsCognitoOAuthOpts } from '../src/types';
 import { AuthClass as Auth } from '../src/Auth';
 import Cache from '@aws-amplify/cache';
-import {
-	CookieStorage,
-	CognitoUserPool,
-	CognitoUser,
-	CognitoUserSession,
-	CognitoIdToken,
-	CognitoAccessToken,
-} from 'amazon-cognito-identity-js';
 import {
 	Credentials,
 	GoogleOAuth,
@@ -814,6 +814,46 @@ describe('auth unit test', () => {
 			spyon.mockClear();
 		});
 
+		test('happy case validationData parameter', async () => {
+			const spyon = jest.spyOn(CognitoUserPool.prototype, 'signUp');
+			const auth = new Auth(authOptionsWithClientMetadata);
+
+			const attrs: SignUpParams = {
+				username: 'username',
+				password: 'password',
+				attributes: {
+					email: 'email',
+					phone_number: 'phone_number',
+					otherAttrs: 'otherAttrs',
+				},
+				clientMetadata: {
+					custom: 'value',
+				},
+				validationData: {
+					foo: 'bar',
+					test: '123',
+				},
+			};
+			await auth.signUp(attrs);
+
+			expect(await spyon).toBeCalledWith(
+				attrs.username,
+				attrs.password,
+				[
+					{ Name: 'email', Value: 'email' },
+					{ Name: 'phone_number', Value: 'phone_number' },
+					{ Name: 'otherAttrs', Value: 'otherAttrs' },
+				],
+				[
+					{ Name: 'foo', Value: 'bar' },
+					{ Name: 'test', Value: '123' },
+				],
+				jasmine.any(Function),
+				{ custom: 'value' }
+			);
+			spyon.mockClear();
+		});
+
 		test('throw error if failed to call currentUserPoolUser after signing in', async () => {
 			const spyon = jest
 				.spyOn(CognitoUser.prototype, 'authenticateUser')

diff --git a/packages/auth/__tests__/oauth-test.ts b/packages/auth/__tests__/oauth-test.ts
@@ -50,7 +50,7 @@ describe('OAuth', () => {
 			};
 			const oAuth = new OAuth({
 				scopes: [],
-				config: config,
+				config,
 				cognitoClientId: '',
 			});
 
@@ -71,7 +71,7 @@ describe('OAuth', () => {
 			};
 			const oAuth = new OAuth({
 				scopes: [],
-				config: config,
+				config,
 				cognitoClientId: '',
 			});
 			const mockAccessToken = 'mockAccessToken';
@@ -107,7 +107,7 @@ describe('OAuth', () => {
 			};
 			const oAuth = new OAuth({
 				scopes: [],
-				config: config,
+				config,
 				cognitoClientId: '',
 			});
 
@@ -130,7 +130,7 @@ describe('OAuth', () => {
 			};
 			const oAuth = new OAuth({
 				scopes: [],
-				config: config,
+				config,
 				cognitoClientId: '',
 			});
 			const mockError = 'mock error';

diff --git a/packages/auth/__tests__/totp-unit-test.ts b/packages/auth/__tests__/totp-unit-test.ts
@@ -149,7 +149,6 @@ jest.mock('amazon-cognito-identity-js/lib/CognitoUser', () => {
 
 	CognitoUser.prototype.associateSoftwareToken = callback => {
 		callback.associateSecretCode('secretCode');
-		//callback.onFailure()
 	};
 
 	CognitoUser.prototype.verifySoftwareToken = (

diff --git a/packages/auth/package.json b/packages/auth/package.json
@@ -19,7 +19,7 @@
     "access": "public"
   },
   "scripts": {
-    "test": "tslint 'src/**/*.ts' && jest -w 1 --coverage",
+    "test": "yarn lint && jest -w 1 --coverage",
     "build-with-test": "npm test && npm run build",
     "build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
     "build:esm": "node ./build es6",
@@ -28,7 +28,7 @@
     "build": "npm run clean && npm run build:esm && npm run build:cjs",
     "clean": "rimraf lib-esm lib dist",
     "format": "echo \"Not implemented\"",
-    "lint": "tslint 'src/**/*.ts'"
+    "lint": "tslint '{__tests__,src}/**/*.ts'"
   },
   "repository": {
     "type": "git",

diff --git a/packages/auth/src/types/Auth.ts b/packages/auth/src/types/Auth.ts
@@ -14,7 +14,6 @@
 import {
 	ICookieStorageData,
 	ICognitoStorage,
-	ICognitoUserAttributeData,
 } from 'amazon-cognito-identity-js';
 
 /**
@@ -24,7 +23,7 @@ export interface SignUpParams {
 	username: string;
 	password: string;
 	attributes?: object;
-	validationData?: ICognitoUserAttributeData[];
+	validationData?: { [key: string]: any };
 	clientMetadata?: { [key: string]: string };
 }