chore: change AuthResetPasswordStep to string union

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

Hide file tree

Showing 7 changed files with 10 additions and 23 deletions.
diff --git a/packages/auth/__tests__/providers/cognito/testUtils/authApiTestParams.ts b/packages/auth/__tests__/providers/cognito/testUtils/authApiTestParams.ts
@@ -2,10 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { decodeJWT } from '@aws-amplify/core/internals/utils';
-import {
-	AuthResetPasswordStep,
-	AuthSignInResult,
-} from '../../../../src/types';
+import { AuthSignInResult } from '../../../../src/types';
 
 export const authAPITestParams = {
 	user1: {
@@ -40,7 +37,7 @@ export const authAPITestParams = {
 	resetPasswordResult: {
 		isPasswordReset: false,
 		nextStep: {
-			resetPasswordStep: AuthResetPasswordStep.CONFIRM_RESET_PASSWORD_WITH_CODE,
+			resetPasswordStep: 'CONFIRM_RESET_PASSWORD_WITH_CODE',
 			codeDeliveryDetails: {
 				destination: '[email protected]',
 				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.22"
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 91.21"
 	},
 	"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 {
-	AuthResetPasswordStep,
 	AuthSignUpStep,
 	AuthUpdateAttributeStep
 } from './types/enums';

diff --git a/packages/auth/src/providers/cognito/apis/resetPassword.ts b/packages/auth/src/providers/cognito/apis/resetPassword.ts
@@ -6,7 +6,6 @@ import { assertTokenProviderConfig } from '@aws-amplify/core/internals/utils';
 import { AuthValidationErrorCode } from '../../../errors/types/validation';
 import { assertValidationError } from '../../../errors/utils/assertValidationError';
 import {
-	AuthResetPasswordStep,
 	AuthStandardAttributeKey,
 	DeliveryMedium,
 	ResetPasswordRequest,
@@ -54,7 +53,7 @@ export async function resetPassword(
 	return {
 		isPasswordReset: false,
 		nextStep: {
-			resetPasswordStep: AuthResetPasswordStep.CONFIRM_RESET_PASSWORD_WITH_CODE,
+			resetPasswordStep: 'CONFIRM_RESET_PASSWORD_WITH_CODE',
 			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
@@ -1,13 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-/**
- * Denotes the next step in the Reset Password process.
- */
-export enum AuthResetPasswordStep {
-	CONFIRM_RESET_PASSWORD_WITH_CODE = 'CONFIRM_RESET_PASSWORD_WITH_CODE',
-	DONE = 'DONE',
-}
 
 
 /**

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

diff --git a/packages/auth/src/types/models.ts b/packages/auth/src/types/models.ts
@@ -1,11 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import {
-	AuthResetPasswordStep,
-	AuthSignUpStep,
-	AuthUpdateAttributeStep,
-} from './enums';
+import { AuthSignUpStep, AuthUpdateAttributeStep } from './enums';
 
 /**
  * Additional data that may be returned from Auth APIs.
@@ -29,7 +25,10 @@ export type AuthCodeDeliveryDetails<
 	deliveryMedium?: DeliveryMedium;
 	attributeName?: UserAttributeKey;
 };
-
+/**
+ * Denotes the next step in the Reset Password process.
+ */
+export type AuthResetPasswordStep = 'CONFIRM_RESET_PASSWORD_WITH_CODE' | 'DONE';
 export type AuthNextResetPasswordStep<
 	UserAttributeKey extends AuthUserAttributeKey = AuthUserAttributeKey
 > = {