@qlover/oauth-wrapper 0.2.1 → 0.3.0

package/dist/index.d.ts

@@ -1,8 +1,80 @@
-import { OAuthClientsInterface, OAuthClientsRepositoryInterface, OAuthClientListItem, OAuthClientDetail, OAuthClientCreate, OAuthClientCreateResponse, OAuthClientUpdate, OAuthClientSecretRotateResponse, OAuthTokenServiceInterface, OAuthUserAdapterInterface, OAuthWrapperRepositoryInterface, OAuthTokenResponse, OAuthTokenRequest, OAuthSessionPayload, OAuthServiceInterface, OAuthSessionInterface, OAuthAuthorizeQuery, OAuthConsentBody, OAuthAuthorizePageData, OAuthAuthorizeValidationError, OAuthConsentResult, OAuthUserInfoResponse, OAuthUserProfile, OAuthRfcCodeType, OAuthClientRow } from './core.js';
-export { CreateAuthorizationCodeInput, CreateOAuthRefreshTokenInput, OAuthAuthorizationCodeRow, OAuthAuthorizationCodeRowSchema, OAuthAuthorizeQuerySchema, OAuthClientCreateResponseSchema, OAuthClientCreateSchema, OAuthClientDetailSchema, OAuthClientListItemSchema, OAuthClientRowSchema, OAuthClientSecretRotateResponseSchema, OAuthClientUpdateSchema, OAuthConsentBodySchema, OAuthRefreshTokenRow, OAuthRefreshTokenSchema, OAuthRfcCodes, OAuthRfcErrorCodesType, OAuthTokenAuthorizationCodeRequest, OAuthTokenAuthorizationCodeSchema, OAuthTokenErrorResponse, OAuthTokenErrorResponseSchema, OAuthTokenRefreshRequest, OAuthTokenRefreshSchema, OAuthTokenRequestSchema, OAuthTokenResponseSchema, OAuthTokenRevokeRequest, OAuthTokenRevokeSchema, OAuthUserAccessToken, OAuthUserCredentials, OAuthUserCredentialsRow, OAuthUserCredentialsSchema, OAuthUserInfoErrorResponse, OAuthUserInfoErrorResponseSchema, OAuthUserInfoResponseSchema, computePkceS256Challenge, generatePkceVerifier, isOAuthRedirectUri, randomOAuthState } from './core.js';
+import { LoginParams } from '@qlover/corekit-bridge/core';
+import { OAuthSessionPayload, OAuthProviderInterface, OAuthTokenRequest, OAuthTokenResponse, OAuthWrapperRepositoryInterface, OAuthUserInfoResponse, OAuthAuthorizeQuery, OAuthConsentBody, OAuthAuthorizePageData, OAuthAuthorizeValidationError, OAuthConsentResult, OAuthClientsInterface, OAuthClientsRepositoryInterface, OAuthClientListItem, OAuthClientDetail, OAuthClientCreate, OAuthClientCreateResponse, OAuthClientUpdate, OAuthClientSecretRotateResponse, OAuthTokenServiceInterface, OAuthSessionInterface, OAuthRfcCodeType, OAuthClientRow } from './core.js';
+export { CreateAuthorizationCodeInput, CreateOAuthRefreshTokenInput, OAuthAuthorizationCodeRow, OAuthAuthorizationCodeRowSchema, OAuthAuthorizeQuerySchema, OAuthClientCreateResponseSchema, OAuthClientCreateSchema, OAuthClientDetailSchema, OAuthClientListItemSchema, OAuthClientRowSchema, OAuthClientSecretRotateResponseSchema, OAuthClientUpdateSchema, OAuthConsentBodySchema, OAuthOTPProviderInterface, OAuthRefreshTokenRow, OAuthRefreshTokenSchema, OAuthRfcCodes, OAuthRfcErrorCodesType, OAuthTokenAuthorizationCodeRequest, OAuthTokenAuthorizationCodeSchema, OAuthTokenErrorResponse, OAuthTokenErrorResponseSchema, OAuthTokenRefreshRequest, OAuthTokenRefreshSchema, OAuthTokenRequestSchema, OAuthTokenResponseSchema, OAuthTokenRevokeRequest, OAuthTokenRevokeSchema, OAuthUserCredentialsRow, OAuthUserCredentialsSchema, OAuthUserInfoErrorResponse, OAuthUserInfoErrorResponseSchema, OAuthUserInfoResponseSchema, ResolveAuthorizePageResult, SignOtpResult, SignWithEmailOtpSchema, SignWithOtpParams, SignWithOtpSchema, SignWithPhoneOtpSchema, VerifyEmailOtpParams, VerifyMobileOtpParams, VerifyOtpParams, computePkceS256Challenge, generatePkceVerifier, isOAuthRedirectUri, randomOAuthState, signWithEmailOtpSchema, signWithPhoneOtpSchema } from './core.js';
 import { EncryptorInterface, ExecutorError } from '@qlover/fe-corekit';
 import 'zod';
-import '@qlover/corekit-bridge/core';
+
+type OAuthUserProfile = {
+    id: string | number;
+    email?: string | null;
+    name?: string | null;
+    roles?: string[];
+    [key: string]: unknown;
+};
+type OAuthUserCredentials = {
+    token: string;
+    [key: string]: unknown;
+};
+type OAuthUserAccessToken = {
+    access_token: string;
+    expires_in: number;
+    refresh_token?: string | null;
+    [key: string]: unknown;
+};
+declare abstract class OAuthAbstractProvider<SessionPayload extends OAuthSessionPayload> implements OAuthProviderInterface<SessionPayload> {
+    protected authCodeTTLMs: number;
+    /**
+     * @override
+     */
+    abstract exchangeToken(_rawFields: Record<string, string> | OAuthTokenRequest): Promise<OAuthTokenResponse>;
+    /**
+     * @override
+     */
+    abstract revokeToken(_rawFields: Record<string, string>): Promise<void>;
+    /**
+     * @override
+     */
+    abstract getOAuthRepo(): OAuthWrapperRepositoryInterface;
+    /**
+     * @override
+     */
+    abstract clearSession(): Promise<void>;
+    /**
+     * @override
+     */
+    abstract getSession(): Promise<SessionPayload | null>;
+    /**
+     * @override
+     */
+    abstract login(params: LoginParams): Promise<SessionPayload>;
+    /**
+     * @override
+     */
+    abstract getUserInfoWithAccessToken(accessToken: string): Promise<OAuthUserInfoResponse>;
+    protected isQuery(query: unknown): query is OAuthAuthorizeQuery;
+    protected isValidateConsent(value: unknown): value is OAuthConsentBody;
+    protected generageSessionPayload(userInfo: OAuthUserProfile & {
+        sessionToken: string;
+    }): SessionPayload;
+    /**
+     * @override
+     */
+    logout(userId: string): Promise<void>;
+    /**
+     * @override
+     */
+    resolveAuthorizePage(rawQuery: Record<string, string | string[] | undefined>): Promise<{
+        ok: true;
+        data: OAuthAuthorizePageData;
+    } | {
+        ok: false;
+        error: OAuthAuthorizeValidationError;
+    }>;
+    /**
+     * @override
+     */
+    processConsent(requestBody: unknown): Promise<OAuthConsentResult>;
+}
 
 /**
  * Business logic for OAuth client management in developer console.
@@ -43,6 +115,10 @@ declare class OAuthClientsService implements OAuthClientsInterface {
     private mapToDetail;
 }
 
+type ExchangeProviderAccessToken = (params: {
+    token: string;
+    lang?: string;
+}) => Promise<OAuthUserAccessToken>;
 /**
  * OAuth 2.0 token endpoint (`POST /oauth/token`).
  *
@@ -55,10 +131,10 @@ declare class OAuthClientsService implements OAuthClientsInterface {
  */
 declare class OAuthTokenService implements OAuthTokenServiceInterface {
     protected tokenEncryption: EncryptorInterface<string, string>;
-    protected userAdapter: OAuthUserAdapterInterface;
+    protected exchangeProviderAccessToken: ExchangeProviderAccessToken;
     protected oauthRepo: OAuthWrapperRepositoryInterface;
     protected static REFRESH_TOKEN_TTL_MS: number;
-    constructor(tokenEncryption: EncryptorInterface<string, string>, userAdapter: OAuthUserAdapterInterface, oauthRepo: OAuthWrapperRepositoryInterface);
+    constructor(tokenEncryption: EncryptorInterface<string, string>, exchangeProviderAccessToken: ExchangeProviderAccessToken, oauthRepo: OAuthWrapperRepositoryInterface);
     /**
      * @override
      */
@@ -87,60 +163,47 @@ declare class OAuthTokenService implements OAuthTokenServiceInterface {
     revokeToken(rawFields: Record<string, string>): Promise<void>;
 }
 
-declare class OAuthWrapperService<SessionPayload extends OAuthSessionPayload = OAuthSessionPayload> implements OAuthServiceInterface<SessionPayload> {
+declare abstract class OAuthWrapperService<SessionPayload extends OAuthSessionPayload = OAuthSessionPayload> extends OAuthAbstractProvider<SessionPayload> {
     protected oauthSession: OAuthSessionInterface<SessionPayload>;
-    protected userAdapter: OAuthUserAdapterInterface;
-    protected tokenService: OAuthTokenServiceInterface;
     protected oauthRepo: OAuthWrapperRepositoryInterface;
-    constructor(oauthSession: OAuthSessionInterface<SessionPayload>, userAdapter: OAuthUserAdapterInterface, tokenService: OAuthTokenServiceInterface, oauthRepo: OAuthWrapperRepositoryInterface);
-    /**
-     * @override
-     */
-    getOAuthSession(): OAuthSessionInterface<SessionPayload>;
-    /**
-     * @override
-     */
-    getOAuthAdapter(): OAuthUserAdapterInterface;
+    protected tokenService: OAuthTokenServiceInterface;
+    constructor(oauthSession: OAuthSessionInterface<SessionPayload>, tokenEncryption: EncryptorInterface<string, string>, oauthRepo: OAuthWrapperRepositoryInterface);
+    protected abstract providerLogin(params: LoginParams): Promise<OAuthUserCredentials>;
+    protected abstract providerExchangeAccessToken(params: {
+        token: string;
+        lang?: string;
+    }): Promise<OAuthUserAccessToken>;
+    protected abstract providerGetUserInfo(sessionToken: string): Promise<OAuthUserProfile>;
+    protected abstract providerGetUserInfoByAccessToken(accessToken: string): Promise<OAuthUserProfile>;
     /**
      * @override
      */
-    getOAuthTokenService(): OAuthTokenServiceInterface;
+    login(params: LoginParams): Promise<SessionPayload>;
     /**
      * @override
      */
     getOAuthRepo(): OAuthWrapperRepositoryInterface;
-    protected isQuery(query: unknown): query is OAuthAuthorizeQuery;
-    protected isValidateConsent(value: unknown): value is OAuthConsentBody;
     /**
      * @override
      */
-    resolveAuthorizePage(rawQuery: Record<string, string | string[] | undefined>): Promise<{
-        ok: true;
-        data: OAuthAuthorizePageData;
-    } | {
-        ok: false;
-        error: OAuthAuthorizeValidationError;
-    }>;
+    exchangeToken(rawFields: Record<string, string>): Promise<OAuthTokenResponse>;
     /**
      * @override
      */
-    processConsent(requestBody: unknown): Promise<OAuthConsentResult>;
+    getSession(): Promise<SessionPayload | null>;
     /**
      * @override
      */
-    exchangeToken(rawFields: Record<string, string>): Promise<OAuthTokenResponse>;
+    clearSession(): Promise<void>;
     /**
      * @override
      */
     revokeToken(rawFields: Record<string, string>): Promise<void>;
-    /**
-     * @override
-     */
     logoutUser(userId: string): Promise<void>;
     /**
      * @override
      */
-    getUserInfo(accessToken: string): Promise<OAuthUserInfoResponse>;
+    getUserInfoWithAccessToken(accessToken: string): Promise<OAuthUserInfoResponse>;
     protected toUserInfoResponse(profile: OAuthUserProfile): OAuthUserInfoResponse;
 }
 
@@ -192,4 +255,4 @@ declare function computeS256CodeChallenge(verifier: string): string;
  */
 declare function verifyPkceS256(verifier: string, challenge: string): boolean;
 
-export { OAuthAuthorizePageData, OAuthAuthorizeQuery, OAuthAuthorizeValidationError, OAuthClientCreate, OAuthClientCreateResponse, OAuthClientDetail, OAuthClientListItem, OAuthClientRow, OAuthClientSecretRotateResponse, OAuthClientUpdate, OAuthClientsInterface, OAuthClientsRepositoryInterface, OAuthClientsService, OAuthConsentBody, OAuthConsentResult, OAuthRfcCodeType, OAuthServiceInterface, OAuthSessionInterface, OAuthSessionPayload, OAuthTokenRequest, OAuthTokenResponse, OAuthTokenService, OAuthTokenServiceInterface, OAuthUserAdapterInterface, OAuthUserInfoResponse, OAuthUserProfile, OAuthWrapperError, OAuthWrapperRepositoryInterface, OAuthWrapperService, buildOAuthRedirectUrl, computeS256CodeChallenge, hashClientSecret, isRedirectUriAllowed, isValidCodeChallenge, isValidCodeVerifier, normalizeQuery, parseScopeList, validatePkceParams, verifyClientSecret, verifyPkceS256 };
+export { type ExchangeProviderAccessToken, OAuthAbstractProvider, OAuthAuthorizePageData, OAuthAuthorizeQuery, OAuthAuthorizeValidationError, OAuthClientCreate, OAuthClientCreateResponse, OAuthClientDetail, OAuthClientListItem, OAuthClientRow, OAuthClientSecretRotateResponse, OAuthClientUpdate, OAuthClientsInterface, OAuthClientsRepositoryInterface, OAuthClientsService, OAuthConsentBody, OAuthConsentResult, OAuthProviderInterface, OAuthRfcCodeType, OAuthSessionInterface, OAuthSessionPayload, OAuthTokenRequest, OAuthTokenResponse, OAuthTokenService, OAuthTokenServiceInterface, type OAuthUserAccessToken, type OAuthUserCredentials, OAuthUserInfoResponse, type OAuthUserProfile, OAuthWrapperError, OAuthWrapperRepositoryInterface, OAuthWrapperService, buildOAuthRedirectUrl, computeS256CodeChallenge, hashClientSecret, isRedirectUriAllowed, isValidCodeChallenge, isValidCodeVerifier, normalizeQuery, parseScopeList, validatePkceParams, verifyClientSecret, verifyPkceS256 };