@thinkingcat/auth-utils 1.0.7 → 1.0.9

package/dist/index.d.ts

@@ -104,18 +104,19 @@ export declare function verifyToken(accessToken: string, secret: string): Promis
 /**
  * payload에서 역할 추출 (서비스별)
  * @param payload JWT payload
- * @param serviceId 서비스 ID (기본값: 'checkon')
+ * @param serviceId 서비스 ID (필수)
  * @param defaultRole 기본 역할 (기본값: 'ADMIN')
  * @returns 추출된 역할
  */
-export declare function extractRoleFromPayload(payload: JWTPayload, serviceId?: string, defaultRole?: string): string;
+export declare function extractRoleFromPayload(payload: JWTPayload, serviceId: string, defaultRole?: string): string;
 /**
  * payload에서 NextAuth JWT 객체 생성
  * @param payload JWT payload
+ * @param serviceId 서비스 ID (필수)
  * @param includeAcademies academies 정보 포함 여부
  * @returns NextAuth JWT 객체
  */
-export declare function createNextAuthJWT(payload: JWTPayload, includeAcademies?: boolean): JWT;
+export declare function createNextAuthJWT(payload: JWTPayload, serviceId: string, includeAcademies?: boolean): JWT;
 /**
  * NextAuth JWT를 인코딩된 세션 토큰으로 변환
  * @param jwt NextAuth JWT 객체
@@ -130,7 +131,7 @@ export declare function encodeNextAuthToken(jwt: JWT, secret: string, maxAge?: n
  * @param accessToken access token
  * @param refreshToken refresh token (선택)
  * @param options 쿠키 설정 옵션
- * @param options.cookiePrefix 쿠키 이름 접두사 (기본값: 'checkon')
+ * @param options.cookiePrefix 쿠키 이름 접두사 (필수)
  * @param options.isProduction 프로덕션 환경 여부 (기본값: false)
  */
 export declare function setCustomTokens(response: ResponseLike, accessToken: string, refreshToken: string, options?: {
@@ -157,10 +158,10 @@ export declare function setNextAuthToken(response: ResponseLike, sessionToken: s
 /**
  * 리다이렉트용 HTML 생성
  * @param redirectPath 리다이렉트할 경로
- * @param text 표시할 텍스트 (기본값: 'checkon')
+ * @param text 표시할 텍스트 (필수)
  * @returns HTML 문자열
  */
-export declare function createRedirectHTML(redirectPath: string, text?: string): string;
+export declare function createRedirectHTML(redirectPath: string, text: string): string;
 /**
  * access token과 refresh token을 사용하여 완전한 인증 세션 생성
  * @param accessToken access token
@@ -168,27 +169,30 @@ export declare function createRedirectHTML(redirectPath: string, text?: string):
  * @param options 추가 옵션
  * @param options.refreshToken refresh token (선택)
  * @param options.redirectPath 리다이렉트할 경로 (기본값: 페이지 리로드)
- * @param options.text 리다이렉트 HTML에 표시할 텍스트 (기본값: 'checkon')
- * @param options.cookiePrefix 쿠키 이름 접두사 (기본값: 'checkon')
+ * @param options.text 리다이렉트 HTML에 표시할 텍스트 (선택사항)
+ * @param options.cookiePrefix 쿠키 이름 접두사 (필수)
  * @param options.isProduction 프로덕션 환경 여부 (기본값: false)
  * @param options.cookieDomain 쿠키 도메인 (선택)
  * @returns NextResponse 객체
  */
-export declare function createAuthResponse(accessToken: string, secret: string, options?: {
+export declare function createAuthResponse(accessToken: string, secret: string, options: {
     refreshToken?: string;
     redirectPath?: string;
     text?: string;
     cookiePrefix?: string;
     isProduction?: boolean;
     cookieDomain?: string;
+    serviceId: string;
+    licenseKey: string;
 }): Promise<NextResponse>;
 /**
  * 서비스 구독 유효성 확인 함수
  * @param services 서비스 정보 배열
  * @param serviceId 확인할 서비스 ID
+ * @param ssoBaseURL SSO 서버 기본 URL (필수)
  * @returns 구독 유효성 결과
  */
-export declare function validateServiceSubscription(services: ServiceInfo[], serviceId: string): {
+export declare function validateServiceSubscription(services: ServiceInfo[], serviceId: string, ssoBaseURL: string): {
     isValid: boolean;
     redirectUrl?: string;
     service?: ServiceInfo;
@@ -197,12 +201,12 @@ export declare function validateServiceSubscription(services: ServiceInfo[], ser
  * SSO 서버에서 refresh token을 사용하여 새로운 access token을 발급받는 함수
  * @param refreshToken refresh token
  * @param options 옵션
- * @param options.ssoBaseURL SSO 서버 기본 URL (기본값: 환경 변수 또는 기본값)
+ * @param options.ssoBaseURL SSO 서버 기본 URL (필수)
  * @param options.authServiceKey 인증 서비스 키 (기본값: 환경 변수)
  * @returns SSO refresh token 응답
  */
-export declare function refreshSSOToken(refreshToken: string, options?: {
-    ssoBaseURL?: string;
+export declare function refreshSSOToken(refreshToken: string, options: {
+    ssoBaseURL: string;
     authServiceKey?: string;
 }): Promise<SSORefreshTokenResponse>;
 /**
@@ -210,35 +214,23 @@ export declare function refreshSSOToken(refreshToken: string, options?: {
  * @param userId 사용자 ID
  * @param accessToken access token
  * @param options 옵션
- * @param options.ssoBaseURL SSO 서버 기본 URL (기본값: 환경 변수 또는 기본값)
+ * @param options.ssoBaseURL SSO 서버 기본 URL (필수)
  * @param options.authServiceKey 인증 서비스 키 (기본값: 환경 변수)
  * @returns refresh token 또는 null
  */
-export declare function getRefreshTokenFromSSO(userId: string, accessToken: string, options?: {
-    ssoBaseURL?: string;
+export declare function getRefreshTokenFromSSO(userId: string, accessToken: string, options: {
+    ssoBaseURL: string;
     authServiceKey?: string;
 }): Promise<string | null>;
-/**
- * 토큰 검증 및 리프레시 처리 공통 함수
- *
- * @param req - NextRequest 객체
- * @param secret - JWT 서명에 사용할 secret key
- * @param options - 옵션
- * @param options.cookiePrefix - 쿠키 이름 접두사 (기본값: 'checkon')
- * @param options.isProduction - 프로덕션 환경 여부 (기본값: false)
- * @param options.cookieDomain - 쿠키 도메인 (선택)
- * @param options.text - 리다이렉트 HTML에 표시할 텍스트 (기본값: 'checkon')
- * @param options.ssoBaseURL - SSO 서버 기본 URL (기본값: 환경 변수 또는 기본값)
- * @param options.authServiceKey - 인증 서비스 키 (기본값: 환경 변수)
- * @returns 검증 결과 및 필요시 리프레시된 응답
- */
-export declare function verifyAndRefreshToken(req: NextRequest, secret: string, options?: {
-    cookiePrefix?: string;
-    isProduction?: boolean;
+export declare function verifyAndRefreshToken(req: NextRequest, secret: string, options: {
+    cookiePrefix: string;
+    serviceId: string;
+    isProduction: boolean;
     cookieDomain?: string;
     text?: string;
     ssoBaseURL?: string;
     authServiceKey?: string;
+    licenseKey: string;
 }): Promise<{
     isValid: boolean;
     response?: NextResponse;
@@ -257,17 +249,17 @@ export declare function redirectToError(req: NextRequest, code: string, message:
 /**
  * 인증 쿠키를 삭제하는 헬퍼 함수
  * @param response NextResponse 객체
- * @param cookiePrefix 쿠키 이름 접두사 (기본값: 'checkon')
+ * @param cookiePrefix 쿠키 이름 접두사 (필수)
  * @returns NextResponse 객체
  */
-export declare function clearAuthCookies(response: NextResponse, cookiePrefix?: string): NextResponse;
+export declare function clearAuthCookies(response: NextResponse, cookiePrefix: string): NextResponse;
 /**
  * JWT에서 서비스별 역할을 추출하는 헬퍼 함수
  * @param token NextAuth JWT 객체 또는 null
- * @param serviceId 서비스 ID (기본값: 'checkon')
+ * @param serviceId 서비스 ID (필수)
  * @returns 추출된 역할 또는 undefined
  */
-export declare function getEffectiveRole(token: JWT | null, serviceId?: string): string | undefined;
+export declare function getEffectiveRole(token: JWT | null, serviceId: string): string | undefined;
 /**
  * 구독이 필요한 경로인지 확인하는 헬퍼 함수
  * @param pathname 경로명
@@ -314,6 +306,26 @@ export interface MiddlewareConfig {
     /** 에러 페이지 경로 (기본값: '/error') */
     errorPath?: string;
 }
+/**
+ * 미들웨어 실행 옵션
+ */
+export interface MiddlewareOptions {
+    /** NextAuth Secret (필수) */
+    secret: string;
+    /** 프로덕션 환경 여부 (필수) */
+    isProduction: boolean;
+    /** 쿠키 도메인 (선택사항) */
+    cookieDomain?: string;
+    /** NextAuth 토큰을 가져오는 함수 (선택사항) */
+    getNextAuthToken?: (req: NextRequest) => Promise<JWT | null>;
+    /** SSO 서버 기본 URL (필수) */
+    ssoBaseURL: string;
+    /** 인증 서비스 키 (선택사항) */
+    authServiceKey?: string;
+    /** 라이센스 키 (필수) */
+    licenseKey: string;
+}
+export declare function checkLicenseKey(licenseKey: string): void;
 export declare function checkRoleAccess(pathname: string, role: string, roleConfig: RoleAccessConfig): {
     allowed: boolean;
     message?: string;
@@ -322,10 +334,10 @@ export declare function checkRoleAccess(pathname: string, role: string, roleConf
  * SSO 로그인 페이지로 리다이렉트하는 헬퍼 함수
  * @param req NextRequest 객체
  * @param serviceId 서비스 ID
- * @param ssoBaseURL SSO 서버 기본 URL (기본값: 환경 변수 또는 기본값)
+ * @param ssoBaseURL SSO 서버 기본 URL (필수)
  * @returns NextResponse 리다이렉트 응답
  */
-export declare function redirectToSSOLogin(req: NextRequest, serviceId: string, ssoBaseURL?: string): NextResponse;
+export declare function redirectToSSOLogin(req: NextRequest, serviceId: string, ssoBaseURL: string): NextResponse;
 /**
  * 역할별 대시보드 경로로 리다이렉트하는 헬퍼 함수
  * @param req NextRequest 객체
@@ -351,18 +363,18 @@ export declare function isValidToken(token: JWT | null): boolean;
  * 특정 역할을 가지고 있는지 확인하는 함수
  * @param token NextAuth JWT 객체
  * @param role 확인할 역할
- * @param serviceId 서비스 ID (기본값: 'checkon')
+ * @param serviceId 서비스 ID (필수)
  * @returns 역할 보유 여부
  */
-export declare function hasRole(token: JWT | null, role: string, serviceId?: string): boolean;
+export declare function hasRole(token: JWT | null, role: string, serviceId: string): boolean;
 /**
  * 여러 역할 중 하나라도 가지고 있는지 확인하는 함수
  * @param token NextAuth JWT 객체
  * @param roles 확인할 역할 배열
- * @param serviceId 서비스 ID (기본값: 'checkon')
+ * @param serviceId 서비스 ID (필수)
  * @returns 역할 보유 여부
  */
-export declare function hasAnyRole(token: JWT | null, roles: string[], serviceId?: string): boolean;
+export declare function hasAnyRole(token: JWT | null, roles: string[], serviceId: string): boolean;
 /**
  * 공개 경로인지 확인하는 함수
  * @param pathname 경로명
@@ -390,14 +402,16 @@ export declare function isProtectedApiPath(pathname: string, exemptPaths?: strin
  * @param options 옵션
  * @returns 인증 결과
  */
-export declare function checkAuthentication(req: NextRequest, secret: string, options?: {
-    cookiePrefix?: string;
-    isProduction?: boolean;
+export declare function checkAuthentication(req: NextRequest, secret: string, options: {
+    cookiePrefix: string;
+    serviceId: string;
+    isProduction: boolean;
     cookieDomain?: string;
     text?: string;
     ssoBaseURL?: string;
     authServiceKey?: string;
     getNextAuthToken?: (req: NextRequest) => Promise<JWT | null>;
+    licenseKey: string;
 }): Promise<{
     isAuthenticated: boolean;
     token?: JWT | null;
@@ -414,13 +428,15 @@ export declare function checkAuthentication(req: NextRequest, secret: string, op
  * @param options 옵션
  * @returns 인증 결과
  */
-export declare function verifyAndRefreshTokenWithNextAuth(req: NextRequest, nextAuthToken: JWT | null, secret: string, options?: {
-    cookiePrefix?: string;
-    isProduction?: boolean;
+export declare function verifyAndRefreshTokenWithNextAuth(req: NextRequest, nextAuthToken: JWT | null, secret: string, options: {
+    cookiePrefix: string;
+    serviceId: string;
+    isProduction: boolean;
     cookieDomain?: string;
     text?: string;
     ssoBaseURL?: string;
     authServiceKey?: string;
+    licenseKey: string;
 }): Promise<{
     isValid: boolean;
     response?: NextResponse;
@@ -429,16 +445,27 @@ export declare function verifyAndRefreshTokenWithNextAuth(req: NextRequest, next
 }>;
 /**
  * 기본 미들웨어 설정을 생성하는 함수
- * @param config 커스텀 설정 (선택사항)
+ * @param config 커스텀 설정 (필수: serviceId 포함)
+ * @param defaults 기본 설정값 (선택사항, 제공하지 않으면 최소 기본값 사용)
  * @returns 미들웨어 설정 객체
  */
-export declare function createMiddlewareConfig(config?: Partial<MiddlewareConfig>): Required<Omit<MiddlewareConfig, 'serviceId'>> & Pick<MiddlewareConfig, 'serviceId'>;
+export declare function createMiddlewareConfig(config: Partial<MiddlewareConfig> & {
+    serviceId: string;
+}, defaults?: {
+    publicPaths?: string[];
+    subscriptionRequiredPaths?: string[];
+    subscriptionExemptApiPaths?: string[];
+    authApiPaths?: string[];
+    rolePaths?: Record<string, string>;
+    systemAdminRole?: string;
+    errorPath?: string;
+}): Required<Omit<MiddlewareConfig, 'serviceId'>> & Pick<MiddlewareConfig, 'serviceId'>;
 /**
  * 통합 미들웨어 핸들러 함수
  * 모든 인증, 권한, 구독 체크를 포함한 완전한 미들웨어 로직
  * @param req NextRequest 객체
  * @param config 미들웨어 설정
- * @param getNextAuthToken NextAuth 토큰을 가져오는 함수
+ * @param options 미들웨어 실행 옵션 (secret 필수)
  * @returns NextResponse 또는 null (다음 미들웨어로 진행)
  */
-export declare function handleMiddleware(req: NextRequest, config: Required<Omit<MiddlewareConfig, 'serviceId'>> & Pick<MiddlewareConfig, 'serviceId'>, getNextAuthToken: (req: NextRequest) => Promise<JWT | null>): Promise<NextResponse | null>;
+export declare function handleMiddleware(req: NextRequest, config: Required<Omit<MiddlewareConfig, 'serviceId'>> & Pick<MiddlewareConfig, 'serviceId'>, options: MiddlewareOptions): Promise<NextResponse | null>;