chore: change AuthSignUpStep to string union

aws-amplify · Sep 13, 2023 · f16ab3a · f16ab3a
1 parent 97ec3e3
commit f16ab3a
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 22 deletions.
diff --git a/packages/auth/__tests__/providers/cognito/confirmSignUp.test.ts b/packages/auth/__tests__/providers/cognito/confirmSignUp.test.ts
@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { confirmSignUp } from '../../../src/providers/cognito';
-import { AuthSignUpStep } from '../../../src/types';
 import * as confirmSignUpClient from '../../../src/providers/cognito/utils/clients/CognitoIdentityProvider';
 import { authAPITestParams } from './testUtils/authApiTestParams';
 import { AuthValidationErrorCode } from '../../../src/errors/types/validation';
@@ -46,7 +45,7 @@ describe('confirmSignUp API Happy Path Cases:', () => {
 		expect(result).toEqual({
 			isSignUpComplete: true,
 			nextStep: {
-				signUpStep: AuthSignUpStep.DONE,
+				signUpStep: 'DONE',
 			},
 		});
 		expect(confirmSignUpClientSpy).toHaveBeenCalledWith(

diff --git a/packages/auth/__tests__/providers/cognito/signUp.test.ts b/packages/auth/__tests__/providers/cognito/signUp.test.ts
@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { signUp } from '../../../src/providers/cognito';
-import { AuthSignUpStep } from '../../../src/types';
 import * as signUpClient from '../../../src/providers/cognito/utils/clients/CognitoIdentityProvider';
 import { authAPITestParams } from './testUtils/authApiTestParams';
 import { AuthValidationErrorCode } from '../../../src/errors/types/validation';
@@ -46,7 +45,7 @@ describe('SignUp API Happy Path Cases:', () => {
 		expect(result).toEqual({
 			isSignUpComplete: false,
 			nextStep: {
-				signUpStep: AuthSignUpStep.CONFIRM_SIGN_UP,
+				signUpStep: 'CONFIRM_SIGN_UP',
 				codeDeliveryDetails: {
 					destination: user1.email,
 					deliveryMedium: 'EMAIL',

diff --git a/packages/auth/package.json b/packages/auth/package.json
@@ -25,7 +25,7 @@
 		"clean:size": "rimraf dual-publish-tmp tmp*",
 		"format": "echo \"Not implemented\"",
 		"lint": "tslint '{src}/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 91.21"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 91.20"
 	},
 	"typesVersions": {
 		">=3.8": {

diff --git a/packages/auth/src/index.ts b/packages/auth/src/index.ts
@@ -23,7 +23,6 @@ export {
 	signOut,
 } from './providers/cognito';
 export {
-	AuthSignUpStep,
 	AuthUpdateAttributeStep
 } from './types/enums';
 

diff --git a/packages/auth/src/providers/cognito/apis/confirmSignUp.ts b/packages/auth/src/providers/cognito/apis/confirmSignUp.ts
@@ -5,7 +5,6 @@ import { Amplify } from '@aws-amplify/core';
 import { assertTokenProviderConfig } from '@aws-amplify/core/internals/utils';
 import {
 	AuthSignUpResult,
-	AuthSignUpStep,
 	AuthStandardAttributeKey,
 	ConfirmSignUpRequest,
 } from '../../../types';
@@ -61,7 +60,7 @@ export async function confirmSignUp(
 	return {
 		isSignUpComplete: true,
 		nextStep: {
-			signUpStep: AuthSignUpStep.DONE,
+			signUpStep: 'DONE',
 		},
 	};
 }
diff --git a/packages/auth/src/providers/cognito/apis/signUp.ts b/packages/auth/src/providers/cognito/apis/signUp.ts
@@ -5,7 +5,6 @@ import { Amplify } from '@aws-amplify/core';
 import { assertTokenProviderConfig } from '@aws-amplify/core/internals/utils';
 import {
 	AuthSignUpResult,
-	AuthSignUpStep,
 	AuthStandardAttributeKey,
 	DeliveryMedium,
 	SignUpRequest,
@@ -79,14 +78,14 @@ export async function signUp(
 		return {
 			isSignUpComplete: true,
 			nextStep: {
-				signUpStep: AuthSignUpStep.DONE,
+				signUpStep: 'DONE',
 			},
 		};
 	} else {
 		return {
 			isSignUpComplete: false,
 			nextStep: {
-				signUpStep: AuthSignUpStep.CONFIRM_SIGN_UP,
+				signUpStep: 'CONFIRM_SIGN_UP',
 				codeDeliveryDetails: {
 					deliveryMedium: CodeDeliveryDetails?.DeliveryMedium as DeliveryMedium,
 					destination: CodeDeliveryDetails?.Destination as string,

diff --git a/packages/auth/src/types/enums.ts b/packages/auth/src/types/enums.ts
@@ -2,15 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 
-
-/**
- * Denotes the next step in the Sign Up process.
- */
-export enum AuthSignUpStep {
-	CONFIRM_SIGN_UP = 'CONFIRM_SIGN_UP',
-	DONE = 'DONE',
-}
-
 /**
  * Denotes the next step in the Update User Attribute process.
  */

diff --git a/packages/auth/src/types/index.ts b/packages/auth/src/types/index.ts
@@ -5,7 +5,6 @@
 export * from './Auth';
 
 export {
-	AuthSignUpStep,
 	AuthUpdateAttributeStep,
 } from './enums';
 
@@ -26,6 +25,7 @@ export {
 	AuthUser,
 	TOTPSetupDetails,
 	AuthResetPasswordStep,
+	AuthSignUpStep
 } from './models';
 
 export { AuthServiceOptions, AuthSignUpOptions } from './options';

diff --git a/packages/auth/src/types/models.ts b/packages/auth/src/types/models.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { AuthSignUpStep, AuthUpdateAttributeStep } from './enums';
+import { AuthUpdateAttributeStep } from './enums';
 
 /**
  * Additional data that may be returned from Auth APIs.
@@ -230,6 +230,11 @@ export type AuthUserAttribute<
  */
 export type AuthUserAttributeKey = AuthStandardAttributeKey | AnyAttribute;
 
+/**
+ * Denotes the next step in the Sign Up process.
+ */
+export type AuthSignUpStep = 'CONFIRM_SIGN_UP' | 'DONE';
+
 /**
  * Data encapsulating the next step in the Sign Up process
  */