@qlover/oauth-wrapper 0.4.0 → 0.6.2

package/dist/client.cjs

@@ -48,7 +48,7 @@ var OAuthWrapperEndpoints = {
   authorize: "/oauth/authorize",
   token: "/oauth/token",
   revoke: "/oauth/revoke",
-  userinfo: "/userinfo"
+  userinfo: "/oauth/userinfo"
 };
 var DEFAULT_OAUTH_AUTHORIZE_PATH = OAuthWrapperEndpoints.authorize;
 var DEFAULT_PKCE_STORAGE_KEY = "oauth-wrapper-pkcesession";

package/dist/client.d.ts

@@ -116,7 +116,7 @@ declare const OAuthWrapperEndpoints: {
     readonly authorize: "/oauth/authorize";
     readonly token: "/oauth/token";
     readonly revoke: "/oauth/revoke";
-    readonly userinfo: "/userinfo";
+    readonly userinfo: "/oauth/userinfo";
 };
 declare const DEFAULT_OAUTH_AUTHORIZE_PATH: "/oauth/authorize";
 type OAuthAuthorizationConfig = {

package/dist/client.js

@@ -3,7 +3,7 @@ var OAuthWrapperEndpoints = {
   authorize: "/oauth/authorize",
   token: "/oauth/token",
   revoke: "/oauth/revoke",
-  userinfo: "/userinfo"
+  userinfo: "/oauth/userinfo"
 };
 var DEFAULT_OAUTH_AUTHORIZE_PATH = OAuthWrapperEndpoints.authorize;
 var DEFAULT_PKCE_STORAGE_KEY = "oauth-wrapper-pkcesession";

package/dist/core.cjs

@@ -190,7 +190,7 @@ var OAuthRefreshTokenSchema = import_zod2.z.object({
 });
 var OAuthTokenResponseSchema = import_zod2.z.object({
   access_token: import_zod2.z.string(),
-  token_type: import_zod2.z.literal("Bearer"),
+  token_type: import_zod2.z.string(),
   expires_in: import_zod2.z.number(),
   refresh_token: import_zod2.z.string().optional(),
   scope: import_zod2.z.string().optional()

package/dist/core.d.ts

@@ -150,16 +150,34 @@ interface OAuthClientsRepositoryInterface {
     verifyClientCredentials(clientId: string, clientSecret: string | undefined): Promise<OAuthClientRow>;
 }
 
-type OAuthSessionPayload = {
+/**
+ * 基础会话载荷，包含 OAuth 核心所需的最少字段。
+ * 子类可以扩展此类型，添加任意额外字段（如 avatar, phone, roles 等）。
+ */
+interface OAuthSessionPayload {
+    /**
+     * 用户唯一标识
+     */
     userId: string;
-    email: string;
-    name: string;
-    providerSessionToken: string;
+    /**
+     * 外部提供方的会话 token
+     */
+    providerRefreshToken: string;
+}
+type WithUserSession<SessionPayload extends OAuthSessionPayload, User> = SessionPayload & {
+    /**
+     * 可以额外携带一个用户信息
+     */
+    user?: User;
 };
-interface OAuthSessionInterface<Payload extends OAuthSessionPayload> {
+/**
+ * 会话管理接口，泛型参数必须满足 OAuthSessionPayload 约束。
+ * 实现类可以返回更具体的子类型（包含额外字段）。
+ */
+interface OAuthSessionInterface<Payload extends OAuthSessionPayload, User> {
     getSession(): Promise<Payload | null>;
     hasSession(): Promise<boolean>;
-    setSession(payload: Payload): Promise<void>;
+    setSession(payload: WithUserSession<Payload, User>): Promise<void>;
     clearSession(): Promise<void>;
 }
 
@@ -230,7 +248,7 @@ declare const OAuthRefreshTokenSchema: z.ZodObject<{
 type OAuthRefreshTokenRow = z.infer<typeof OAuthRefreshTokenSchema>;
 declare const OAuthTokenResponseSchema: z.ZodObject<{
     access_token: z.ZodString;
-    token_type: z.ZodLiteral<"Bearer">;
+    token_type: z.ZodString;
     expires_in: z.ZodNumber;
     refresh_token: z.ZodOptional<z.ZodString>;
     scope: z.ZodOptional<z.ZodString>;
@@ -276,19 +294,6 @@ interface OAuthWrapperRepositoryInterface extends OAuthClientsRepositoryInterfac
     revokeRefreshTokensByUserId(userId: string): Promise<void>;
 }
 
-declare const OAuthUserInfoResponseSchema: z.ZodObject<{
-    sub: z.ZodString;
-    email: z.ZodEmail;
-    name: z.ZodString;
-    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.core.$strip>;
-type OAuthUserInfoResponse = z.infer<typeof OAuthUserInfoResponseSchema>;
-declare const OAuthUserInfoErrorResponseSchema: z.ZodObject<{
-    error: z.ZodString;
-    error_id: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type OAuthUserInfoErrorResponse = z.infer<typeof OAuthUserInfoErrorResponseSchema>;
-
 /**
  * OAuth authorize page data shared by server rendering and client UI.
  *
@@ -335,7 +340,7 @@ type ResolveAuthorizePageResult = {
     ok: false;
     error: OAuthAuthorizeValidationError;
 };
-interface OAuthProviderInterface<SessionPayload extends OAuthSessionPayload> extends OAuthTokenServiceInterface {
+interface OAuthProviderInterface<User, SessionPayload extends OAuthSessionPayload> extends OAuthTokenServiceInterface {
     login(params: LoginParams): Promise<SessionPayload>;
     /**
      * Get the OAuth repository
@@ -361,7 +366,18 @@ interface OAuthProviderInterface<SessionPayload extends OAuthSessionPayload> ext
      * Process the consent
      */
     processConsent(requestBody: unknown): Promise<OAuthConsentResult>;
-    getUserInfoWithAccessToken(accessToken: string): Promise<OAuthUserInfoResponse>;
+    /**
+     * 使用 access_token 获取用户信息
+     * @param accessToken
+     */
+    getUserInfoWithAccessToken(accessToken: string): Promise<User>;
+    /**
+     * 刷新会话数据
+     * @param params
+     */
+    refreshUser(params?: {
+        refresh_token: string;
+    }): Promise<WithUserSession<SessionPayload, User>>;
 }
 type SignWithOtpParams = {
     email: string;
@@ -411,6 +427,31 @@ interface OAuthOTPProviderInterface {
     verifyOtp(params: VerifyOtpParams): Promise<SignOtpResult>;
 }
 
+/**
+ * @deprecated
+ */
+declare const OAuthUserInfoResponseSchema: z.ZodObject<{
+    sub: z.ZodString;
+    email: z.ZodEmail;
+    name: z.ZodString;
+    roles: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+/**
+ * @deprecated
+ */
+type OAuthUserInfoResponse = z.infer<typeof OAuthUserInfoResponseSchema>;
+/**
+ * @deprecated
+ */
+declare const OAuthUserInfoErrorResponseSchema: z.ZodObject<{
+    error: z.ZodString;
+    error_id: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * @deprecated
+ */
+type OAuthUserInfoErrorResponse = z.infer<typeof OAuthUserInfoErrorResponseSchema>;
+
 declare const OAuthRfcCodes: {
     readonly INVALID_REQUEST: "invalid_request";
     readonly INVALID_CLIENT: "invalid_client";
@@ -433,4 +474,4 @@ declare function generatePkceVerifier(length?: number): string;
 declare function computePkceS256Challenge(verifier: string): Promise<string>;
 declare function randomOAuthState(): string;
 
-export { type CreateAuthorizationCodeInput, type CreateOAuthRefreshTokenInput, type OAuthAuthorizationCodeRow, OAuthAuthorizationCodeRowSchema, type OAuthAuthorizePageData, type OAuthAuthorizeQuery, OAuthAuthorizeQuerySchema, type OAuthAuthorizeValidationError, type OAuthClientCreate, type OAuthClientCreateResponse, OAuthClientCreateResponseSchema, OAuthClientCreateSchema, type OAuthClientDetail, OAuthClientDetailSchema, type OAuthClientListItem, OAuthClientListItemSchema, type OAuthClientRow, OAuthClientRowSchema, type OAuthClientSecretRotateResponse, OAuthClientSecretRotateResponseSchema, type OAuthClientUpdate, OAuthClientUpdateSchema, type OAuthClientsInterface, type OAuthClientsRepositoryInterface, type OAuthConsentBody, OAuthConsentBodySchema, type OAuthConsentResult, type OAuthOTPProviderInterface, type OAuthProviderInterface, type OAuthRefreshTokenRow, OAuthRefreshTokenSchema, type OAuthRfcCodeType, OAuthRfcCodes, type OAuthRfcErrorCodesType, type OAuthSessionInterface, type OAuthSessionPayload, type OAuthTokenAuthorizationCodeRequest, OAuthTokenAuthorizationCodeSchema, type OAuthTokenErrorResponse, OAuthTokenErrorResponseSchema, type OAuthTokenRefreshRequest, OAuthTokenRefreshSchema, type OAuthTokenRequest, OAuthTokenRequestSchema, type OAuthTokenResponse, OAuthTokenResponseSchema, type OAuthTokenRevokeRequest, OAuthTokenRevokeSchema, type OAuthTokenServiceInterface, type OAuthUserCredentialsRow, OAuthUserCredentialsSchema, type OAuthUserInfoErrorResponse, OAuthUserInfoErrorResponseSchema, type OAuthUserInfoResponse, OAuthUserInfoResponseSchema, type OAuthWrapperRepositoryInterface, type ResolveAuthorizePageResult, type SignOtpResult, type SignWithEmailOtpSchema, type SignWithOtpParams, type SignWithOtpSchema, type SignWithPhoneOtpSchema, type VerifyEmailOtpParams, type VerifyMobileOtpParams, type VerifyOtpParams, computePkceS256Challenge, generatePkceVerifier, isOAuthRedirectUri, randomOAuthState, signWithEmailOtpSchema, signWithPhoneOtpSchema };
+export { type CreateAuthorizationCodeInput, type CreateOAuthRefreshTokenInput, type OAuthAuthorizationCodeRow, OAuthAuthorizationCodeRowSchema, type OAuthAuthorizePageData, type OAuthAuthorizeQuery, OAuthAuthorizeQuerySchema, type OAuthAuthorizeValidationError, type OAuthClientCreate, type OAuthClientCreateResponse, OAuthClientCreateResponseSchema, OAuthClientCreateSchema, type OAuthClientDetail, OAuthClientDetailSchema, type OAuthClientListItem, OAuthClientListItemSchema, type OAuthClientRow, OAuthClientRowSchema, type OAuthClientSecretRotateResponse, OAuthClientSecretRotateResponseSchema, type OAuthClientUpdate, OAuthClientUpdateSchema, type OAuthClientsInterface, type OAuthClientsRepositoryInterface, type OAuthConsentBody, OAuthConsentBodySchema, type OAuthConsentResult, type OAuthOTPProviderInterface, type OAuthProviderInterface, type OAuthRefreshTokenRow, OAuthRefreshTokenSchema, type OAuthRfcCodeType, OAuthRfcCodes, type OAuthRfcErrorCodesType, type OAuthSessionInterface, type OAuthSessionPayload, type OAuthTokenAuthorizationCodeRequest, OAuthTokenAuthorizationCodeSchema, type OAuthTokenErrorResponse, OAuthTokenErrorResponseSchema, type OAuthTokenRefreshRequest, OAuthTokenRefreshSchema, type OAuthTokenRequest, OAuthTokenRequestSchema, type OAuthTokenResponse, OAuthTokenResponseSchema, type OAuthTokenRevokeRequest, OAuthTokenRevokeSchema, type OAuthTokenServiceInterface, type OAuthUserCredentialsRow, OAuthUserCredentialsSchema, type OAuthUserInfoErrorResponse, OAuthUserInfoErrorResponseSchema, type OAuthUserInfoResponse, OAuthUserInfoResponseSchema, type OAuthWrapperRepositoryInterface, type ResolveAuthorizePageResult, type SignOtpResult, type SignWithEmailOtpSchema, type SignWithOtpParams, type SignWithOtpSchema, type SignWithPhoneOtpSchema, type VerifyEmailOtpParams, type VerifyMobileOtpParams, type VerifyOtpParams, type WithUserSession, computePkceS256Challenge, generatePkceVerifier, isOAuthRedirectUri, randomOAuthState, signWithEmailOtpSchema, signWithPhoneOtpSchema };

package/dist/core.js

@@ -138,7 +138,7 @@ var OAuthRefreshTokenSchema = z2.object({
 });
 var OAuthTokenResponseSchema = z2.object({
   access_token: z2.string(),
-  token_type: z2.literal("Bearer"),
+  token_type: z2.string(),
   expires_in: z2.number(),
   refresh_token: z2.string().optional(),
   scope: z2.string().optional()