feat(express): support custom auth routes prefix (#538)

logto-io · Aug 10, 2023 · 27f6a53 · 27f6a53
1 parent dedeaae
commit 27f6a53
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/.changeset/dull-scissors-walk.md b/.changeset/dull-scissors-walk.md
@@ -0,0 +1,5 @@
+---
+"@logto/express": minor
+---
+
+Support custom auth routes prefix
diff --git a/packages/express/src/index.test.ts b/packages/express/src/index.test.ts
@@ -63,6 +63,14 @@ describe('Express', () => {
         expect(response.header.location).toEqual(signInUrl);
         expect(signIn).toHaveBeenCalled();
       });
+
+      it('should support custom auth routes prefix', async () => {
+        const response = await testRouter(
+          handleAuthRoutes({ ...configs, authRoutesPrefix: 'custom' })
+        ).get('/custom/sign-in');
+        expect(response.header.location).toEqual(signInUrl);
+        expect(signIn).toHaveBeenCalled();
+      });
     });
 
     describe('handleSignUn', () => {

diff --git a/packages/express/src/index.ts b/packages/express/src/index.ts
@@ -43,20 +43,21 @@ const createNodeClient = (
 export const handleAuthRoutes = (config: LogtoExpressConfig): Router => {
   // eslint-disable-next-line new-cap
   const router = Router();
+  const prefix = config.authRoutesPrefix ?? 'logto';
 
-  router.use('/logto/:action', async (request, response) => {
+  router.use(`/${prefix}/:action`, async (request, response) => {
     const { action } = request.params;
     const nodeClient = createNodeClient(request, response, config);
 
     switch (action) {
       case 'sign-in': {
-        await nodeClient.signIn(`${config.baseUrl}/logto/sign-in-callback`);
+        await nodeClient.signIn(`${config.baseUrl}/${prefix}/sign-in-callback`);
 
         break;
       }
 
       case 'sign-up': {
-        await nodeClient.signIn(`${config.baseUrl}/logto/sign-in-callback`, 'signUp');
+        await nodeClient.signIn(`${config.baseUrl}/${prefix}/sign-in-callback`, 'signUp');
 
         break;
       }

diff --git a/packages/express/src/types.ts b/packages/express/src/types.ts
@@ -10,4 +10,5 @@ declare module 'http' {
 
 export type LogtoExpressConfig = LogtoConfig & {
   baseUrl: string;
+  authRoutesPrefix?: string;
 } & GetContextParameters;