refactor(core): rename prefix to account

packages/core/src/routes/account-center/index.openapi.json

@@ -11,6 +11,7 @@
   "paths": {
     "/api/account-center": {
       "get": {
+        "operationId": "GetAccountCenterSettings",
         "summary": "Get account center settings",
         "description": "Get the account center settings.",
         "responses": {
@@ -20,6 +21,7 @@
         }
       },
       "patch": {
+        "operationId": "UpdateAccountCenterSettings",
         "summary": "Update account center settings",
         "description": "Update the account center settings with the provided settings.",
         "requestBody": {

packages/core/src/routes/account/constants.ts

@@ -0,0 +1 @@
+export const accountApiPrefix = '/account';

packages/core/src/routes/profile/email-and-phone.ts → packages/core/src/routes/account/email-and-phone.ts

@@ -9,6 +9,8 @@ import { buildVerificationRecordByIdAndType } from '../../libraries/verification
 import assertThat from '../../utils/assert-that.js';
 import type { UserRouter, RouterInitArgs } from '../types.js';
 
+import { accountApiPrefix } from './constants.js';
+
 export default function emailAndPhoneRoutes<T extends UserRouter>(...args: RouterInitArgs<T>) {
   const [router, { queries, libraries }] = args;
   const {
@@ -21,7 +23,7 @@ export default function emailAndPhoneRoutes<T extends UserRouter>(...args: Route
   } = libraries;
 
   router.post(
-    '/profile/primary-email',
+    `${accountApiPrefix}/primary-email`,
     koaGuard({
       body: z.object({
         email: z.string().regex(emailRegEx),
@@ -67,7 +69,7 @@ export default function emailAndPhoneRoutes<T extends UserRouter>(...args: Route
   );
 
   router.delete(
-    '/profile/primary-email',
+    `${accountApiPrefix}/primary-email`,
     koaGuard({
       status: [204, 400, 401],
     }),
@@ -106,7 +108,7 @@ export default function emailAndPhoneRoutes<T extends UserRouter>(...args: Route
   );
 
   router.post(
-    '/profile/primary-phone',
+    `${accountApiPrefix}/primary-phone`,
     koaGuard({
       body: z.object({
         phone: z.string().regex(phoneRegEx),
@@ -152,7 +154,7 @@ export default function emailAndPhoneRoutes<T extends UserRouter>(...args: Route
   );
 
   router.delete(
-    '/profile/primary-phone',
+    `${accountApiPrefix}/primary-phone`,
     koaGuard({
       status: [204, 400, 401],
     }),

packages/core/src/routes/profile/identities.ts → packages/core/src/routes/account/identities.ts

@@ -9,6 +9,8 @@ import { buildVerificationRecordByIdAndType } from '../../libraries/verification
 import assertThat from '../../utils/assert-that.js';
 import type { UserRouter, RouterInitArgs } from '../types.js';
 
+import { accountApiPrefix } from './constants.js';
+
 export default function identitiesRoutes<T extends UserRouter>(
   ...[router, { queries, libraries }]: RouterInitArgs<T>
 ) {
@@ -21,7 +23,7 @@ export default function identitiesRoutes<T extends UserRouter>(
   } = libraries;
 
   router.post(
-    '/profile/identities',
+    `${accountApiPrefix}/identities`,
     koaGuard({
       body: z.object({
         newIdentifierVerificationRecordId: z.string(),
@@ -81,7 +83,7 @@ export default function identitiesRoutes<T extends UserRouter>(
   );
 
   router.delete(
-    '/profile/identities/:target',
+    `${accountApiPrefix}/identities/:target`,
     koaGuard({
       params: z.object({ target: z.string() }),
       status: [204, 400, 401, 404],

packages/core/src/routes/profile/index.openapi.json → packages/core/src/routes/account/index.openapi.json

@@ -1,15 +1,15 @@
 {
   "tags": [
     {
-      "name": "Profile",
-      "description": "Profile routes provide functionality for managing user profiles for the end user to interact directly with access tokens."
+      "name": "Account",
+      "description": "Account routes provide functionality for managing user profile for the end user to interact directly with access tokens."
     },
     {
       "name": "Dev feature"
     }
   ],
   "paths": {
-    "/api/profile": {
+    "/api/account": {
       "get": {
         "operationId": "GetProfile",
         "summary": "Get profile",
@@ -56,7 +56,7 @@
         }
       }
     },
-    "/api/profile/profile": {
+    "/api/account/profile": {
       "patch": {
         "operationId": "UpdateOtherProfile",
         "summary": "Update other profile",
@@ -114,7 +114,7 @@
         }
       }
     },
-    "/api/profile/password": {
+    "/api/account/password": {
       "post": {
         "operationId": "UpdatePassword",
         "summary": "Update password",
@@ -142,7 +142,7 @@
         }
       }
     },
-    "/api/profile/primary-email": {
+    "/api/account/primary-email": {
       "post": {
         "operationId": "UpdatePrimaryEmail",
         "summary": "Update primary email",
@@ -186,7 +186,7 @@
         }
       }
     },
-    "/api/profile/primary-phone": {
+    "/api/account/primary-phone": {
       "post": {
         "operationId": "UpdatePrimaryPhone",
         "summary": "Update primary phone",
@@ -230,7 +230,7 @@
         }
       }
     },
-    "/api/profile/identities": {
+    "/api/account/identities": {
       "post": {
         "operationId": "AddUserIdentities",
         "summary": "Add a user identity",
@@ -255,7 +255,7 @@
         }
       }
     },
-    "/api/profile/identities/{target}": {
+    "/api/account/identities/{target}": {
       "delete": {
         "operationId": "DeleteIdentity",
         "summary": "Delete a user identity",

packages/core/src/routes/profile/index.ts → packages/core/src/routes/account/index.ts

@@ -16,12 +16,13 @@ import assertThat from '../../utils/assert-that.js';
 import { PasswordValidator } from '../experience/classes/libraries/password-validator.js';
 import type { UserRouter, RouterInitArgs } from '../types.js';
 
+import { accountApiPrefix } from './constants.js';
 import emailAndPhoneRoutes from './email-and-phone.js';
 import identitiesRoutes from './identities.js';
 import koaAccountCenter from './middlewares/koa-account-center.js';
 import { getAccountCenterFilteredProfile, getScopedProfile } from './utils/get-scoped-profile.js';
 
-export default function profileRoutes<T extends UserRouter>(...args: RouterInitArgs<T>) {
+export default function accountRoutes<T extends UserRouter>(...args: RouterInitArgs<T>) {
   const [router, { queries, libraries }] = args;
   const {
     users: { updateUserById, findUserById },
@@ -39,7 +40,7 @@ export default function profileRoutes<T extends UserRouter>(...args: RouterInitA
   }
 
   router.get(
-    '/profile',
+    `${accountApiPrefix}`,
     koaGuard({
       response: userProfileResponseGuard.partial(),
       status: [200],
@@ -53,7 +54,7 @@ export default function profileRoutes<T extends UserRouter>(...args: RouterInitA
   );
 
   router.patch(
-    '/profile',
+    `${accountApiPrefix}`,
     koaGuard({
       body: z.object({
         name: z.string().nullable().optional(),
@@ -111,7 +112,7 @@ export default function profileRoutes<T extends UserRouter>(...args: RouterInitA
   );
 
   router.patch(
-    '/profile/profile',
+    `${accountApiPrefix}/profile`,
     koaGuard({
       body: userProfileGuard,
       response: userProfileGuard,
@@ -146,7 +147,7 @@ export default function profileRoutes<T extends UserRouter>(...args: RouterInitA
   );
 
   router.post(
-    '/profile/password',
+    `${accountApiPrefix}/password`,
     koaGuard({
       body: z.object({ password: z.string().min(1) }),
       status: [204, 400, 401, 422],

packages/core/src/routes/init.ts

@@ -13,6 +13,8 @@
 import koaOidcAuth from '../middleware/koa-auth/koa-oidc-auth.js';
 import koaCors from '../middleware/koa-cors.js';
 
+import { accountApiPrefix } from './account/constants.js';
+import accountRoutes from './account/index.js';
 import accountCentersRoutes from './account-center/index.js';
 import adminUserRoutes from './admin-user/index.js';
 import applicationOrganizationRoutes from './applications/application-organization.js';
@@ -34,7 +36,6 @@
 import logRoutes from './log.js';
 import logtoConfigRoutes from './logto-config/index.js';
 import organizationRoutes from './organization/index.js';
-import profileRoutes from './profile/index.js';
 import resourceRoutes from './resource.js';
 import resourceScopeRoutes from './resource.scope.js';
 import roleRoutes from './role.js';
@@ -47,7 +48,7 @@
 import systemRoutes from './system.js';
 import type { AnonymousRouter, ManagementApiRouter, UserRouter } from './types.js';
 import userAssetsRoutes from './user-assets.js';
-import verificationRoutes from './verification/index.js';
+import verificationRoutes, { verificationApiPrefix } from './verification/index.js';
 import verificationCodeRoutes from './verification-code.js';
 import wellKnownRoutes from './well-known/index.js';
 import wellKnownOpenApiRoutes from './well-known/well-known.openapi.js';
@@ -66,7 +67,7 @@
   managementRouter.use(koaTenantGuard(tenant.id, tenant.queries));
   managementRouter.use(koaManagementApiHooks(tenant.libraries.hooks));
 
   // TODO: FIXME @sijie @darcy mount these routes in `applicationRoutes` instead
   applicationRoutes(managementRouter, tenant);
   applicationRoleRoutes(managementRouter, tenant);
   applicationProtectedAppMetadataRoutes(managementRouter, tenant);
@@ -105,9 +106,9 @@
 
   const userRouter: UserRouter = new Router();
   userRouter.use(koaOidcAuth(tenant));
   // TODO(LOG-10147): Rename to koaApiHooks, this middleware is used for both management API and user API
   userRouter.use(koaManagementApiHooks(tenant.libraries.hooks));
-  profileRoutes(userRouter, tenant);
+  accountRoutes(userRouter, tenant);
   verificationRoutes(userRouter, tenant);
 
   wellKnownRoutes(anonymousRouter, tenant);
@@ -126,7 +127,7 @@
     anonymousRouter,
     experienceRouter,
     userRouter,
     // TODO: interactionRouter should be removed from swagger.json
     interactionRouter,
   ]);
 
@@ -136,7 +137,7 @@
 export default function initApis(tenant: TenantContext): Koa {
   const apisApp = new Koa();
   const { adminUrlSet, cloudUrlSet } = EnvSet.values;
-  apisApp.use(koaCors([adminUrlSet, cloudUrlSet], ['/profile', '/verifications']));
+  apisApp.use(koaCors([adminUrlSet, cloudUrlSet], [accountApiPrefix, verificationApiPrefix]));
   apisApp.use(koaBodyEtag());
 
   for (const router of createRouters(tenant)) {

packages/core/src/routes/swagger/utils/operation-id.ts

@@ -124,7 +124,7 @@ const exceptionPrefixes = Object.freeze([
   '/interaction',
   '/experience',
   '/sign-in-exp/default/check-password',
-  '/profile',
+  '/account',
   '/verifications',
 ]);
 

packages/core/src/routes/types.ts

@@ -7,7 +7,7 @@
 import { type WithHookContext } from '#src/middleware/koa-management-api-hooks.js';
 import type TenantContext from '#src/tenants/TenantContext.js';
 
-import { type WithAccountCenterContext } from './profile/middlewares/koa-account-center.js';
+import { type WithAccountCenterContext } from './account/middlewares/koa-account-center.js';
 
 export type AnonymousRouter = Router<unknown, WithLogContext & WithI18nContext>;
 

packages/core/src/routes/verification/index.ts

@@ -24,6 +24,8 @@ import { PasswordVerification } from '../experience/classes/verifications/passwo
 import { SocialVerification } from '../experience/classes/verifications/social-verification.js';
 import type { UserRouter, RouterInitArgs } from '../types.js';
 
+export const verificationApiPrefix = '/verifications';
+
 export default function verificationRoutes<T extends UserRouter>(
   ...[router, tenantContext]: RouterInitArgs<T>
 ) {
@@ -34,7 +36,7 @@ export default function verificationRoutes<T extends UserRouter>(
   }
 
   router.post(
-    '/verifications/password',
+    `${verificationApiPrefix}/password`,
     koaGuard({
       body: z.object({ password: z.string().min(1) }),
       response: z.object({ verificationRecordId: z.string(), expiresAt: z.string() }),
@@ -76,7 +78,7 @@ export default function verificationRoutes<T extends UserRouter>(
   );
 
   router.post(
-    '/verifications/verification-code',
+    `${verificationApiPrefix}/verification-code`,
     koaGuard({
       body: z.object({
         identifier: verificationCodeIdentifierGuard,
@@ -119,7 +121,7 @@ export default function verificationRoutes<T extends UserRouter>(
   );
 
   router.post(
-    '/verifications/verification-code/verify',
+    `${verificationApiPrefix}/verification-code/verify`,
     koaGuard({
       body: z.object({
         identifier: verificationCodeIdentifierGuard,
@@ -164,7 +166,7 @@ export default function verificationRoutes<T extends UserRouter>(
   );
 
   router.post(
-    '/verifications/social',
+    `${verificationApiPrefix}/social`,
     koaGuard({
       body: socialAuthorizationUrlPayloadGuard.extend({
         connectorId: z.string(),
@@ -202,7 +204,7 @@ export default function verificationRoutes<T extends UserRouter>(
   );
 
   router.post(
-    '/verifications/social/verify',
+    `${verificationApiPrefix}/social/verify`,
     koaGuard({
       body: socialVerificationCallbackPayloadGuard
         .pick({

packages/core/src/routes/well-known/well-known.openapi.ts

@@ -31,7 +31,7 @@
 
     // Find supplemental documents
     const supplementDocuments = await getSupplementDocuments('routes', {
-      excludeDirectories: ['experience', 'interaction', 'profile', 'verification'],
+      excludeDirectories: ['experience', 'interaction', 'account', 'verification'],
     });
     const baseDocument = buildManagementApiBaseDocument(pathMap, tags, ctx.request.origin);
 
@@ -71,7 +71,7 @@
 
     // Find supplemental documents
     const supplementDocuments = await getSupplementDocuments('routes', {
-      includeDirectories: ['profile', 'verification'],
+      includeDirectories: ['account', 'verification'],
     });
     const baseDocument = buildUserApiBaseDocument(pathMap, tags, ctx.request.origin);