From b5512b9213ddfeaa0701983cf3d68ef7f59e09a5 Mon Sep 17 00:00:00 2001 From: simeng-li Date: Wed, 26 Oct 2022 14:47:13 +0800 Subject: [PATCH] refactor(core): rename phone signInMethod to sms (#2252) Co-authored-by: Xiao Yijun --- .../tabs/SignUpAndSignInTab/constants.ts | 14 +++++++------- packages/core/src/__mocks__/sign-in-experience.ts | 2 +- .../src/lib/sign-in-experience/sign-in.test.ts | 12 ++++++------ .../core/src/lib/sign-in-experience/sign-in.ts | 10 +++++----- .../src/lib/sign-in-experience/sign-up.test.ts | 8 ++++---- .../core/src/lib/sign-in-experience/sign-up.ts | 8 ++++---- .../session/middleware/passwordless-action.ts | 8 ++++---- .../core/src/routes/session/passwordless.test.ts | 4 ++-- .../src/routes/session/username-password.test.ts | 2 +- .../integration-tests/tests/api/session.test.ts | 2 +- .../en/translation/admin-console/sign-in-exp.ts | 4 ++-- .../fr/translation/admin-console/sign-in-exp.ts | 4 ++-- .../ko/translation/admin-console/sign-in-exp.ts | 4 ++-- .../pt-pt/translation/admin-console/sign-in-exp.ts | 4 ++-- .../tr-tr/translation/admin-console/sign-in-exp.ts | 4 ++-- .../zh-cn/translation/admin-console/sign-in-exp.ts | 4 ++-- .../alterations/next-1665300135-sign-in-sign-up.ts | 12 ++++++------ packages/schemas/src/foundations/jsonb-types.ts | 6 +++--- packages/schemas/src/seeds/sign-in-experience.ts | 2 +- packages/ui/src/__mocks__/logto.tsx | 2 +- 20 files changed, 58 insertions(+), 58 deletions(-) diff --git a/packages/console/src/pages/SignInExperience/tabs/SignUpAndSignInTab/constants.ts b/packages/console/src/pages/SignInExperience/tabs/SignUpAndSignInTab/constants.ts index 7ace9114d..1c1171c59 100644 --- a/packages/console/src/pages/SignInExperience/tabs/SignUpAndSignInTab/constants.ts +++ b/packages/console/src/pages/SignInExperience/tabs/SignUpAndSignInTab/constants.ts @@ -6,15 +6,15 @@ export const signInIdentifiers = Object.values(SignInIdentifier); export const requiredVerifySignUpIdentifiers = [ SignUpIdentifier.Email, - SignUpIdentifier.Phone, - SignUpIdentifier.EmailOrPhone, + SignUpIdentifier.Sms, + SignUpIdentifier.EmailOrSms, ]; export const signUpToSignInIdentifierMapping: { [key in SignUpIdentifier]: SignInIdentifier[] } = { [SignUpIdentifier.Username]: [SignInIdentifier.Username], [SignUpIdentifier.Email]: [SignInIdentifier.Email], - [SignUpIdentifier.Phone]: [SignInIdentifier.Phone], - [SignUpIdentifier.EmailOrPhone]: [SignInIdentifier.Email, SignInIdentifier.Phone], + [SignUpIdentifier.Sms]: [SignInIdentifier.Sms], + [SignUpIdentifier.EmailOrSms]: [SignInIdentifier.Email, SignInIdentifier.Sms], [SignUpIdentifier.None]: [], }; @@ -23,8 +23,8 @@ export const signUpIdentifierToRequiredConnectorMapping: { } = { [SignUpIdentifier.Username]: [], [SignUpIdentifier.Email]: [ConnectorType.Email], - [SignUpIdentifier.Phone]: [ConnectorType.Sms], - [SignUpIdentifier.EmailOrPhone]: [ConnectorType.Email, ConnectorType.Sms], + [SignUpIdentifier.Sms]: [ConnectorType.Sms], + [SignUpIdentifier.EmailOrSms]: [ConnectorType.Email, ConnectorType.Sms], [SignUpIdentifier.None]: [], }; @@ -33,5 +33,5 @@ export const signInIdentifierToRequiredConnectorMapping: { } = { [SignInIdentifier.Username]: [], [SignInIdentifier.Email]: [ConnectorType.Email], - [SignInIdentifier.Phone]: [ConnectorType.Sms], + [SignInIdentifier.Sms]: [ConnectorType.Sms], }; diff --git a/packages/core/src/__mocks__/sign-in-experience.ts b/packages/core/src/__mocks__/sign-in-experience.ts index a44a2b002..6b3fc5c3b 100644 --- a/packages/core/src/__mocks__/sign-in-experience.ts +++ b/packages/core/src/__mocks__/sign-in-experience.ts @@ -55,7 +55,7 @@ export const mockSignInExperience: SignInExperience = { isPasswordPrimary: true, }, { - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, password: true, verificationCode: true, isPasswordPrimary: true, diff --git a/packages/core/src/lib/sign-in-experience/sign-in.test.ts b/packages/core/src/lib/sign-in-experience/sign-in.test.ts index fba849fbd..578328ae3 100644 --- a/packages/core/src/lib/sign-in-experience/sign-in.test.ts +++ b/packages/core/src/lib/sign-in-experience/sign-in.test.ts @@ -26,14 +26,14 @@ describe('validate sign-in', () => { }, { ...mockSignInMethod, - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, verificationCode: true, }, ], }, { ...mockSignUp, - identifier: SignUpIdentifier.EmailOrPhone, + identifier: SignUpIdentifier.EmailOrSms, password: false, verify: true, }, @@ -95,7 +95,7 @@ describe('validate sign-in', () => { methods: [ { ...mockSignInMethod, - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, }, ], }, @@ -119,7 +119,7 @@ describe('validate sign-in', () => { methods: [ { ...mockSignInMethod, - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, }, ], }, @@ -173,7 +173,7 @@ describe('validate sign-in', () => { }, { ...mockSignUp, - identifier: SignUpIdentifier.Phone, + identifier: SignUpIdentifier.Sms, }, enabledConnectors ); @@ -197,7 +197,7 @@ describe('validate sign-in', () => { }, { ...mockSignUp, - identifier: SignUpIdentifier.EmailOrPhone, + identifier: SignUpIdentifier.EmailOrSms, }, enabledConnectors ); diff --git a/packages/core/src/lib/sign-in-experience/sign-in.ts b/packages/core/src/lib/sign-in-experience/sign-in.ts index ee0ba7327..774d06386 100644 --- a/packages/core/src/lib/sign-in-experience/sign-in.ts +++ b/packages/core/src/lib/sign-in-experience/sign-in.ts @@ -21,7 +21,7 @@ export const validateSignIn = ( ); } - if (signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Phone)) { + if (signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Sms)) { assertThat( enabledConnectors.some((item) => item.type === ConnectorType.Sms), new RequestError({ @@ -54,9 +54,9 @@ export const validateSignIn = ( break; } - case SignUpIdentifier.Phone: { + case SignUpIdentifier.Sms: { assertThat( - signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Phone), + signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Sms), new RequestError({ code: 'sign_in_experiences.miss_sign_up_identifier_in_sign_in', }) @@ -65,10 +65,10 @@ export const validateSignIn = ( break; } - case SignUpIdentifier.EmailOrPhone: { + case SignUpIdentifier.EmailOrSms: { assertThat( signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Email) && - signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Phone), + signIn.methods.some(({ identifier }) => identifier === SignInIdentifier.Sms), new RequestError({ code: 'sign_in_experiences.miss_sign_up_identifier_in_sign_in', }) diff --git a/packages/core/src/lib/sign-in-experience/sign-up.test.ts b/packages/core/src/lib/sign-in-experience/sign-up.test.ts index bf279acdc..da13214f2 100644 --- a/packages/core/src/lib/sign-in-experience/sign-up.test.ts +++ b/packages/core/src/lib/sign-in-experience/sign-up.test.ts @@ -22,7 +22,7 @@ describe('validate sign-up', () => { test('should throw when there is no enabled email connector and identifier is email or phone', async () => { expect(() => { - validateSignUp({ ...mockSignUp, identifier: SignUpIdentifier.EmailOrPhone }, []); + validateSignUp({ ...mockSignUp, identifier: SignUpIdentifier.EmailOrSms }, []); }).toMatchError( new RequestError({ code: 'sign_in_experiences.enabled_connector_not_found', @@ -33,7 +33,7 @@ describe('validate sign-up', () => { test('should throw when there is no enabled sms connector and identifier is phone', async () => { expect(() => { - validateSignUp({ ...mockSignUp, identifier: SignUpIdentifier.Phone }, []); + validateSignUp({ ...mockSignUp, identifier: SignUpIdentifier.Sms }, []); }).toMatchError( new RequestError({ code: 'sign_in_experiences.enabled_connector_not_found', @@ -44,7 +44,7 @@ describe('validate sign-up', () => { test('should throw when there is no enabled email connector and identifier is email or phone', async () => { expect(() => { - validateSignUp({ ...mockSignUp, identifier: SignUpIdentifier.EmailOrPhone }, [ + validateSignUp({ ...mockSignUp, identifier: SignUpIdentifier.EmailOrSms }, [ mockAliyunDmConnector, ]); }).toMatchError( @@ -99,7 +99,7 @@ describe('validate sign-up', () => { test('should throw when identifier is email or phone', async () => { expect(() => { validateSignUp( - { ...mockSignUp, identifier: SignUpIdentifier.EmailOrPhone, verify: false }, + { ...mockSignUp, identifier: SignUpIdentifier.EmailOrSms, verify: false }, enabledConnectors ); }).toMatchError( diff --git a/packages/core/src/lib/sign-in-experience/sign-up.ts b/packages/core/src/lib/sign-in-experience/sign-up.ts index f7b04554e..2cde0c596 100644 --- a/packages/core/src/lib/sign-in-experience/sign-up.ts +++ b/packages/core/src/lib/sign-in-experience/sign-up.ts @@ -8,7 +8,7 @@ import assertThat from '@/utils/assert-that'; export const validateSignUp = (signUp: SignUp, enabledConnectors: LogtoConnector[]) => { if ( signUp.identifier === SignUpIdentifier.Email || - signUp.identifier === SignUpIdentifier.EmailOrPhone + signUp.identifier === SignUpIdentifier.EmailOrSms ) { assertThat( enabledConnectors.some((item) => item.type === ConnectorType.Email), @@ -20,8 +20,8 @@ export const validateSignUp = (signUp: SignUp, enabledConnectors: LogtoConnector } if ( - signUp.identifier === SignUpIdentifier.Phone || - signUp.identifier === SignUpIdentifier.EmailOrPhone + signUp.identifier === SignUpIdentifier.Sms || + signUp.identifier === SignUpIdentifier.EmailOrSms ) { assertThat( enabledConnectors.some((item) => item.type === ConnectorType.Sms), @@ -42,7 +42,7 @@ export const validateSignUp = (signUp: SignUp, enabledConnectors: LogtoConnector } if ( - [SignUpIdentifier.Phone, SignUpIdentifier.Email, SignUpIdentifier.EmailOrPhone].includes( + [SignUpIdentifier.Sms, SignUpIdentifier.Email, SignUpIdentifier.EmailOrSms].includes( signUp.identifier ) ) { diff --git a/packages/core/src/routes/session/middleware/passwordless-action.ts b/packages/core/src/routes/session/middleware/passwordless-action.ts index cba8a0141..1ea1c7e3a 100644 --- a/packages/core/src/routes/session/middleware/passwordless-action.ts +++ b/packages/core/src/routes/session/middleware/passwordless-action.ts @@ -31,7 +31,7 @@ export const smsSignInAction = - identifier === SignInIdentifier.Phone && verificationCode + identifier === SignInIdentifier.Sms && verificationCode ), new RequestError({ code: 'user.sign_in_method_not_enabled', @@ -117,8 +117,8 @@ export const smsRegisterAction = { const signInExperience = await findDefaultSignInExperience(); assertThat( - signInExperience.signUp.identifier === SignUpIdentifier.Phone || - signInExperience.signUp.identifier === SignUpIdentifier.EmailOrPhone, + signInExperience.signUp.identifier === SignUpIdentifier.Sms || + signInExperience.signUp.identifier === SignUpIdentifier.EmailOrSms, new RequestError({ code: 'user.sign_up_method_not_enabled', status: 422, @@ -159,7 +159,7 @@ export const emailRegisterAction = passwordlessRoutes', () => { ...mockSignInExperience, signUp: { ...mockSignInExperience.signUp, - identifier: SignUpIdentifier.Phone, + identifier: SignUpIdentifier.Sms, }, }); }); @@ -895,7 +895,7 @@ describe('session -> passwordlessRoutes', () => { ...mockSignInExperience, signUp: { ...mockSignInExperience.signUp, - identifier: SignUpIdentifier.Phone, + identifier: SignUpIdentifier.Sms, }, }); diff --git a/packages/core/src/routes/session/username-password.test.ts b/packages/core/src/routes/session/username-password.test.ts index 95e2cf0e8..794dd652b 100644 --- a/packages/core/src/routes/session/username-password.test.ts +++ b/packages/core/src/routes/session/username-password.test.ts @@ -153,7 +153,7 @@ describe('sessionRoutes', () => { methods: [ { ...mockSignInMethod, - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, password: false, }, ], diff --git a/packages/integration-tests/tests/api/session.test.ts b/packages/integration-tests/tests/api/session.test.ts index b1c41ab67..2477a347e 100644 --- a/packages/integration-tests/tests/api/session.test.ts +++ b/packages/integration-tests/tests/api/session.test.ts @@ -121,7 +121,7 @@ describe('email passwordless flow', () => { describe('sms passwordless flow', () => { beforeAll(async () => { await setUpConnector(mockSmsConnectorId, mockSmsConnectorConfig); - await setSignUpIdentifier(SignUpIdentifier.Phone); + await setSignUpIdentifier(SignUpIdentifier.Sms); }); // Since we can not create a sms register user throw admin. Have to run the register then sign-in concurrently. diff --git a/packages/phrases/src/locales/en/translation/admin-console/sign-in-exp.ts b/packages/phrases/src/locales/en/translation/admin-console/sign-in-exp.ts index febfa27e6..5d0e323a5 100644 --- a/packages/phrases/src/locales/en/translation/admin-console/sign-in-exp.ts +++ b/packages/phrases/src/locales/en/translation/admin-console/sign-in-exp.ts @@ -41,9 +41,9 @@ const sign_in_exp = { sign_up_and_sign_in: { identifiers: 'Sign up identifiers', identifiers_email: 'Email address', - identifiers_phone: 'Phone number', + identifiers_sms: 'Phone number', identifiers_username: 'Username', - identifiers_email_or_phone: 'Email address or phone number', + identifiers_email_or_sms: 'Email address or phone number', identifiers_none: 'None', sign_up: { title: 'SIGN UP', diff --git a/packages/phrases/src/locales/fr/translation/admin-console/sign-in-exp.ts b/packages/phrases/src/locales/fr/translation/admin-console/sign-in-exp.ts index be4426a83..5c76f1741 100644 --- a/packages/phrases/src/locales/fr/translation/admin-console/sign-in-exp.ts +++ b/packages/phrases/src/locales/fr/translation/admin-console/sign-in-exp.ts @@ -43,9 +43,9 @@ const sign_in_exp = { sign_up_and_sign_in: { identifiers: 'Sign up identifiers', // UNTRANSLATED identifiers_email: 'Email address', // UNTRANSLATED - identifiers_phone: 'Phone number', // UNTRANSLATED + identifiers_sms: 'Phone number', // UNTRANSLATED identifiers_username: 'Username', // UNTRANSLATED - identifiers_email_or_phone: 'Email address or phone number', // UNTRANSLATED + identifiers_email_or_sms: 'Email address or phone number', // UNTRANSLATED identifiers_none: 'None', // UNTRANSLATED sign_up: { title: 'SIGN UP', // UNTRANSLATED diff --git a/packages/phrases/src/locales/ko/translation/admin-console/sign-in-exp.ts b/packages/phrases/src/locales/ko/translation/admin-console/sign-in-exp.ts index 46747dff7..1d3bf579b 100644 --- a/packages/phrases/src/locales/ko/translation/admin-console/sign-in-exp.ts +++ b/packages/phrases/src/locales/ko/translation/admin-console/sign-in-exp.ts @@ -38,9 +38,9 @@ const sign_in_exp = { sign_up_and_sign_in: { identifiers: 'Sign up identifiers', // UNTRANSLATED identifiers_email: 'Email address', // UNTRANSLATED - identifiers_phone: 'Phone number', // UNTRANSLATED + identifiers_sms: 'Phone number', // UNTRANSLATED identifiers_username: 'Username', // UNTRANSLATED - identifiers_email_or_phone: 'Email address or phone number', // UNTRANSLATED + identifiers_email_or_sms: 'Email address or phone number', // UNTRANSLATED identifiers_none: 'None', // UNTRANSLATED sign_up: { title: 'SIGN UP', // UNTRANSLATED diff --git a/packages/phrases/src/locales/pt-pt/translation/admin-console/sign-in-exp.ts b/packages/phrases/src/locales/pt-pt/translation/admin-console/sign-in-exp.ts index 4670fea70..0d295f9df 100644 --- a/packages/phrases/src/locales/pt-pt/translation/admin-console/sign-in-exp.ts +++ b/packages/phrases/src/locales/pt-pt/translation/admin-console/sign-in-exp.ts @@ -41,9 +41,9 @@ const sign_in_exp = { sign_up_and_sign_in: { identifiers: 'Sign up identifiers', // UNTRANSLATED identifiers_email: 'Email address', // UNTRANSLATED - identifiers_phone: 'Phone number', // UNTRANSLATED + identifiers_sms: 'Phone number', // UNTRANSLATED identifiers_username: 'Username', // UNTRANSLATED - identifiers_email_or_phone: 'Email address or phone number', // UNTRANSLATED + identifiers_email_or_sms: 'Email address or phone number', // UNTRANSLATED identifiers_none: 'None', // UNTRANSLATED sign_up: { title: 'SIGN UP', // UNTRANSLATED diff --git a/packages/phrases/src/locales/tr-tr/translation/admin-console/sign-in-exp.ts b/packages/phrases/src/locales/tr-tr/translation/admin-console/sign-in-exp.ts index da38d9271..9233e80be 100644 --- a/packages/phrases/src/locales/tr-tr/translation/admin-console/sign-in-exp.ts +++ b/packages/phrases/src/locales/tr-tr/translation/admin-console/sign-in-exp.ts @@ -42,9 +42,9 @@ const sign_in_exp = { sign_up_and_sign_in: { identifiers: 'Sign up identifiers', // UNTRANSLATED identifiers_email: 'Email address', // UNTRANSLATED - identifiers_phone: 'Phone number', // UNTRANSLATED + identifiers_sms: 'Phone number', // UNTRANSLATED identifiers_username: 'Username', // UNTRANSLATED - identifiers_email_or_phone: 'Email address or phone number', // UNTRANSLATED + identifiers_email_or_sms: 'Email address or phone number', // UNTRANSLATED identifiers_none: 'None', // UNTRANSLATED sign_up: { title: 'SIGN UP', // UNTRANSLATED diff --git a/packages/phrases/src/locales/zh-cn/translation/admin-console/sign-in-exp.ts b/packages/phrases/src/locales/zh-cn/translation/admin-console/sign-in-exp.ts index b9df20f14..1184e2176 100644 --- a/packages/phrases/src/locales/zh-cn/translation/admin-console/sign-in-exp.ts +++ b/packages/phrases/src/locales/zh-cn/translation/admin-console/sign-in-exp.ts @@ -39,9 +39,9 @@ const sign_in_exp = { sign_up_and_sign_in: { identifiers: 'Sign up identifiers', // UNTRANSLATED identifiers_email: 'Email address', // UNTRANSLATED - identifiers_phone: 'Phone number', // UNTRANSLATED + identifiers_sms: 'Phone number', // UNTRANSLATED identifiers_username: 'Username', // UNTRANSLATED - identifiers_email_or_phone: 'Email address or phone number', // UNTRANSLATED + identifiers_email_or_sms: 'Email address or phone number', // UNTRANSLATED identifiers_none: 'None', // UNTRANSLATED sign_up: { title: 'SIGN UP', // UNTRANSLATED diff --git a/packages/schemas/alterations/next-1665300135-sign-in-sign-up.ts b/packages/schemas/alterations/next-1665300135-sign-in-sign-up.ts index a410e3540..f04ab1b5c 100644 --- a/packages/schemas/alterations/next-1665300135-sign-in-sign-up.ts +++ b/packages/schemas/alterations/next-1665300135-sign-in-sign-up.ts @@ -1,6 +1,6 @@ import { sql } from 'slonik'; -import { AlterationScript } from '../lib/types/alteration'; +import type { AlterationScript } from '../lib/types/alteration'; enum SignInMethodState { Primary = 'primary', @@ -26,15 +26,15 @@ type SignInExperience = { enum SignUpIdentifier { Email = 'email', - Phone = 'phone', + Sms = 'sms', Username = 'username', - EmailOrPhone = 'emailOrPhone', + EmailOrSms = 'emailOrSms', None = 'none', } enum SignInIdentifier { Email = 'email', - Phone = 'phone', + Sms = 'Sms', Username = 'username', } @@ -65,7 +65,7 @@ const parseSignInMethodToSignInIdentifier = ( } if (method === SignInMethodKey.Sms) { - return SignInIdentifier.Phone; + return SignInIdentifier.Sms; } }; @@ -79,7 +79,7 @@ const parseSignInMethodToSignUpIdentifier = (method?: SignInMethodKey): SignUpId } if (method === SignInMethodKey.Sms) { - return SignUpIdentifier.Phone; + return SignUpIdentifier.Sms; } return SignUpIdentifier.None; diff --git a/packages/schemas/src/foundations/jsonb-types.ts b/packages/schemas/src/foundations/jsonb-types.ts index ceb28d3f3..564d2cfbf 100644 --- a/packages/schemas/src/foundations/jsonb-types.ts +++ b/packages/schemas/src/foundations/jsonb-types.ts @@ -152,9 +152,9 @@ export type SignInMethods = z.infer; export enum SignUpIdentifier { Email = 'email', - Phone = 'phone', + Sms = 'sms', Username = 'username', - EmailOrPhone = 'emailOrPhone', + EmailOrSms = 'emailOrSms', None = 'none', } @@ -168,7 +168,7 @@ export type SignUp = z.infer; export enum SignInIdentifier { Email = 'email', - Phone = 'phone', + Sms = 'sms', Username = 'username', } diff --git a/packages/schemas/src/seeds/sign-in-experience.ts b/packages/schemas/src/seeds/sign-in-experience.ts index daa9ef1c3..654b7c601 100644 --- a/packages/schemas/src/seeds/sign-in-experience.ts +++ b/packages/schemas/src/seeds/sign-in-experience.ts @@ -50,7 +50,7 @@ export const defaultSignInExperience: Readonly = { isPasswordPrimary: false, }, { - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, password: true, verificationCode: true, isPasswordPrimary: false, diff --git a/packages/ui/src/__mocks__/logto.tsx b/packages/ui/src/__mocks__/logto.tsx index fa6b84be4..b57a1d2e8 100644 --- a/packages/ui/src/__mocks__/logto.tsx +++ b/packages/ui/src/__mocks__/logto.tsx @@ -201,7 +201,7 @@ export const mockSignInExperience: SignInExperience = { isPasswordPrimary: true, }, { - identifier: SignInIdentifier.Phone, + identifier: SignInIdentifier.Sms, password: true, verificationCode: false, isPasswordPrimary: true,