프레임워크 통합 만들기
Auth.js의 핵심 기능인 @auth/core는 웹 표준 Request/Response 모델을 기반으로 구축되어 있어 프레임워크에 구애받지 않습니다. 각 프레임워크에 대해, 우리는 해당 프레임워크에 특화된 방식으로 인증 기능을 사용할 수 있도록 통합 레이어를 제공합니다. 현재 사용 가능한 통합 목록을 참고하세요.
새로운 공식 통합을 기여하는 것을 환영합니다. 새로운 통합을 만들고 유지 관리하는 데 관심이 있다면, 다음 가이드라인을 읽어보세요.
공식 프레임워크 가이드라인
새로운 공식 프레임워크 통합을 만들고 @auth/ 네임스페이스 아래에 배포하려면 다음 단계를 따르고 아래의 유지보수 요구사항을 충족해야 합니다:
새로운 통합 설정하기
우리는 새로운 통합을 위해 필요한 모든 파일을 생성해주는 스크립트를 제공합니다. 이 스크립트를 실행하려면 다음 명령어를 입력하세요:
npm setup-fw-integration <framework-name>이 명령어는 ./packages/frameworks-template에 있는 공식 템플릿 파일을 packages/ 디렉토리 아래의 새로운 디렉토리로 복사하고, 플레이스홀더를 여러분이 제공한 프레임워크 이름으로 변경합니다.
-
코딩 스타일: 소스 코드 파일은 다음을 준수해야 합니다:
- TypeScript로 작성되어야 함
- 모노레포의 린트 규칙을 통과해야 함
- 메인 모듈에서 명명된 내보내기가 있어야 함. 예:
export function ExpressAuth()
-
API 참조 문서: 우리는 자동화된 문서 생성을 위해 TypeDoc을 사용합니다. 문서는 다음을 포함해야 합니다:
- JSDoc 주석으로 작성되어야 함
- 통합을 사용하고 설정하는 방법 설명: 세션 관리, 로그인/로그아웃, 기본 URL 설정 방법 등
- 참조 섹션에 공식 프레임워크 문서 링크 포함
-
배포된 예제: 이 작업은 후속 PR에서 진행할 수 있습니다. 배포된 예제는 다음을 충족해야 합니다:
- 모든 액션(URL)이 예상대로 작동해야 함
- 최소 하나의 OAuth 프로바이더가 설정되어 있어야 함
- 예제 코드는
apps/examples/<framework-name>아래에 위치해야 함. 예:apps/examples/express
위 항목들은 우리가 패키지를 공식 패키지로 배포하기 위해 필수입니다. 체크리스트를 모두 완료하면 PR을 “리뷰 준비 완료”로 표시할 수 있으며, 메인테이너들이 리뷰를 진행할 것입니다.