@qlover/oauth-wrapper 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.2.1
+
+### Patch Changes
+
+#### ♻️ Refactors
+
+- **oauth-wrapper:** change userId type from number to string across interfaces and schemas ([bfe85fa](https://github.com/qlover/fe-base/commit/bfe85fa6e82561164a936dca7e8a9d8e1ca6b7e3)) ([#618](https://github.com/qlover/fe-base/pull/618))
+  - Updated the `ownerUserId` and `userId` parameters in various interfaces and schemas to use `string` instead of `number` for better compatibility with string-based identifiers.
+  - Adjusted related service methods to reflect the new type, ensuring consistency across the OAuth wrapper implementation.
+  - Enhanced the `OAuthClientRowSchema` and other schemas to align with the updated user ID type, improving data validation and integrity.
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/core.cjs

@@ -64,7 +64,7 @@ function isOAuthRedirectUri(value) {
 }
 var oauthRedirectUriSchema = import_zod.z.string().min(1).refine(isOAuthRedirectUri, { message: "Invalid redirect URI" });
 var OAuthClientRowSchema = import_zod.z.object({
-  id: import_zod.z.number(),
+  id: import_zod.z.string(),
   client_id: import_zod.z.string(),
   client_secret_hash: import_zod.z.string().nullable().optional(),
   client_name: import_zod.z.string(),
@@ -74,7 +74,7 @@ var OAuthClientRowSchema = import_zod.z.object({
   grant_types: import_zod.z.array(import_zod.z.string()),
   scopes: import_zod.z.array(import_zod.z.string()),
   confidential: import_zod.z.boolean(),
-  owner_user_id: import_zod.z.number(),
+  owner_user_id: import_zod.z.string(),
   created_at: import_zod.z.string(),
   updated_at: import_zod.z.string()
 });
@@ -147,7 +147,7 @@ var OAuthConsentBodySchema = import_zod.z.object({
 var OAuthAuthorizationCodeRowSchema = import_zod.z.object({
   code: import_zod.z.string(),
   client_id: import_zod.z.string(),
-  user_id: import_zod.z.number(),
+  user_id: import_zod.z.string(),
   redirect_uri: import_zod.z.string(),
   scope: import_zod.z.string().nullable().optional(),
   code_challenge: import_zod.z.string().nullable().optional(),
@@ -160,16 +160,16 @@ var OAuthAuthorizationCodeRowSchema = import_zod.z.object({
 // src/core/schema/OAuthClientSchema.ts
 var import_zod2 = require("zod");
 var OAuthUserCredentialsSchema = import_zod2.z.object({
-  user_id: import_zod2.z.number(),
+  user_id: import_zod2.z.string(),
   provider_refresh_token: import_zod2.z.string().nullable().optional(),
   provider_session_token: import_zod2.z.string().nullable().optional(),
   updated_at: import_zod2.z.string()
 });
 var OAuthRefreshTokenSchema = import_zod2.z.object({
-  id: import_zod2.z.number(),
+  id: import_zod2.z.string(),
   refresh_token: import_zod2.z.string(),
   client_id: import_zod2.z.string(),
-  user_id: import_zod2.z.number(),
+  user_id: import_zod2.z.string(),
   expires_at: import_zod2.z.string(),
   revoked: import_zod2.z.boolean(),
   created_at: import_zod2.z.string()

package/dist/core.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { LoginParams } from '@qlover/corekit-bridge/core';
 import { ValueOf } from '@qlover/fe-corekit';
 
 /**
@@ -6,7 +7,7 @@ import { ValueOf } from '@qlover/fe-corekit';
  */
 declare function isOAuthRedirectUri(value: string): boolean;
 declare const OAuthClientRowSchema: z.ZodObject<{
-    id: z.ZodNumber;
+    id: z.ZodString;
     client_id: z.ZodString;
     client_secret_hash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     client_name: z.ZodString;
@@ -16,7 +17,7 @@ declare const OAuthClientRowSchema: z.ZodObject<{
     grant_types: z.ZodArray<z.ZodString>;
     scopes: z.ZodArray<z.ZodString>;
     confidential: z.ZodBoolean;
-    owner_user_id: z.ZodNumber;
+    owner_user_id: z.ZodString;
     created_at: z.ZodString;
     updated_at: z.ZodString;
 }, z.core.$strip>;
@@ -100,7 +101,7 @@ type OAuthConsentBody = z.infer<typeof OAuthConsentBodySchema>;
 declare const OAuthAuthorizationCodeRowSchema: z.ZodObject<{
     code: z.ZodString;
     client_id: z.ZodString;
-    user_id: z.ZodNumber;
+    user_id: z.ZodString;
     redirect_uri: z.ZodString;
     scope: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     code_challenge: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -112,12 +113,12 @@ declare const OAuthAuthorizationCodeRowSchema: z.ZodObject<{
 type OAuthAuthorizationCodeRow = z.infer<typeof OAuthAuthorizationCodeRowSchema>;
 
 interface OAuthClientsInterface {
-    listForOwner(ownerUserId: number): Promise<OAuthClientListItem[]>;
-    getByClientId(ownerUserId: number, clientId: string): Promise<OAuthClientDetail>;
-    create(ownerUserId: number, input: OAuthClientCreate): Promise<OAuthClientCreateResponse>;
-    update(ownerUserId: number, clientId: string, input: OAuthClientUpdate): Promise<OAuthClientDetail>;
-    rotateSecret(ownerUserId: number, clientId: string): Promise<OAuthClientSecretRotateResponse>;
-    delete(ownerUserId: number, clientId: string): Promise<void>;
+    listForOwner(ownerUserId: string): Promise<OAuthClientListItem[]>;
+    getByClientId(ownerUserId: string, clientId: string): Promise<OAuthClientDetail>;
+    create(ownerUserId: string, input: OAuthClientCreate): Promise<OAuthClientCreateResponse>;
+    update(ownerUserId: string, clientId: string, input: OAuthClientUpdate): Promise<OAuthClientDetail>;
+    rotateSecret(ownerUserId: string, clientId: string): Promise<OAuthClientSecretRotateResponse>;
+    delete(ownerUserId: string, clientId: string): Promise<void>;
 }
 
 /**
@@ -125,21 +126,21 @@ interface OAuthClientsInterface {
  */
 interface OAuthClientsRepositoryInterface {
     findClientById(clientId: string): Promise<OAuthClientRow | null>;
-    listClientByOwner(ownerUserId: number): Promise<OAuthClientListItem[]>;
-    createClient(ownerUserId: number, input: OAuthClientCreate): Promise<{
+    listClientByOwner(ownerUserId: string): Promise<OAuthClientListItem[]>;
+    createClient(ownerUserId: string, input: OAuthClientCreate): Promise<{
         client: OAuthClientRow;
         clientSecret?: string;
     }>;
-    updateClient(ownerUserId: number, clientId: string, input: OAuthClientUpdate): Promise<OAuthClientDetail>;
-    rotateClientSecret(ownerUserId: number, clientId: string): Promise<{
+    updateClient(ownerUserId: string, clientId: string, input: OAuthClientUpdate): Promise<OAuthClientDetail>;
+    rotateClientSecret(ownerUserId: string, clientId: string): Promise<{
         clientSecret: string;
     }>;
-    deleteClient(ownerUserId: number, clientId: string): Promise<void>;
+    deleteClient(ownerUserId: string, clientId: string): Promise<void>;
     verifyClientCredentials(clientId: string, clientSecret: string | undefined): Promise<OAuthClientRow>;
 }
 
 type OAuthSessionPayload = {
-    userId: number;
+    userId: string;
     email: string;
     name: string;
     providerSessionToken: string;
@@ -270,7 +271,7 @@ interface OAuthUserAdapterInterface {
      * @param password - Plain credential submitted by the login form.
      * @returns Provider credentials containing a session token.
      */
-    login(email: string, password: string): Promise<OAuthUserCredentials>;
+    login(params: LoginParams): Promise<OAuthUserCredentials>;
     /**
      * Exchanges a provider session token for a provider access token.
      *
@@ -298,17 +299,17 @@ interface OAuthUserAdapterInterface {
 }
 
 declare const OAuthUserCredentialsSchema: z.ZodObject<{
-    user_id: z.ZodNumber;
+    user_id: z.ZodString;
     provider_refresh_token: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     provider_session_token: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     updated_at: z.ZodString;
 }, z.core.$strip>;
 type OAuthUserCredentialsRow = z.infer<typeof OAuthUserCredentialsSchema>;
 declare const OAuthRefreshTokenSchema: z.ZodObject<{
-    id: z.ZodNumber;
+    id: z.ZodString;
     refresh_token: z.ZodString;
     client_id: z.ZodString;
-    user_id: z.ZodNumber;
+    user_id: z.ZodString;
     expires_at: z.ZodString;
     revoked: z.ZodBoolean;
     created_at: z.ZodString;
@@ -326,7 +327,7 @@ type OAuthTokenResponse = z.infer<typeof OAuthTokenResponseSchema>;
 type CreateAuthorizationCodeInput = {
     code: string;
     client_id: string;
-    user_id: number;
+    user_id: string;
     redirect_uri: string;
     scope: string | null;
     code_challenge: string | null;
@@ -336,14 +337,14 @@ type CreateAuthorizationCodeInput = {
 type CreateOAuthRefreshTokenInput = {
     refresh_token: string;
     client_id: string;
-    user_id: number;
+    user_id: string;
     expires_at: string;
 };
 interface OAuthWrapperRepositoryInterface extends OAuthClientsRepositoryInterface {
     create(input: CreateAuthorizationCodeInput): Promise<void>;
     consumeCode(code: string): Promise<OAuthAuthorizationCodeRow | null>;
-    getUserCredentials(userId: number): Promise<OAuthUserCredentialsRow | null>;
-    upsertUserCredentials(userId: number, fields: {
+    getUserCredentials(userId: string): Promise<OAuthUserCredentialsRow | null>;
+    upsertUserCredentials(userId: string, fields: {
         provider_refresh_token?: string | null;
         provider_session_token?: string | null;
     }): Promise<void>;
@@ -351,7 +352,7 @@ interface OAuthWrapperRepositoryInterface extends OAuthClientsRepositoryInterfac
     upsertRefreshToken(input: {
         refresh_token: string;
         client_id: string;
-        user_id: number;
+        user_id: string;
         expires_at: string;
     }): Promise<void>;
     revokeRefreshToken(tokenHash: string): Promise<void>;
@@ -359,7 +360,7 @@ interface OAuthWrapperRepositoryInterface extends OAuthClientsRepositoryInterfac
     createRefreshToken(input: CreateOAuthRefreshTokenInput): Promise<void>;
     revokeByTokenHash(tokenHash: string): Promise<void>;
     /** Revoke all active refresh tokens issued for the given user. */
-    revokeRefreshTokensByUserId(userId: number): Promise<void>;
+    revokeRefreshTokensByUserId(userId: string): Promise<void>;
 }
 
 declare const OAuthUserInfoResponseSchema: z.ZodObject<{
@@ -432,7 +433,7 @@ interface OAuthServiceInterface<SessionPayload extends OAuthSessionPayload> exte
      * Application logout: revoke issued refresh tokens, clear stored provider
      * credentials, and clear the authorization-server session cookie.
      */
-    logoutUser(userId: number): Promise<void>;
+    logoutUser(userId: string): Promise<void>;
 }
 
 declare const OAuthRfcCodes: {

package/dist/core.js

@@ -14,7 +14,7 @@ function isOAuthRedirectUri(value) {
 }
 var oauthRedirectUriSchema = z.string().min(1).refine(isOAuthRedirectUri, { message: "Invalid redirect URI" });
 var OAuthClientRowSchema = z.object({
-  id: z.number(),
+  id: z.string(),
   client_id: z.string(),
   client_secret_hash: z.string().nullable().optional(),
   client_name: z.string(),
@@ -24,7 +24,7 @@ var OAuthClientRowSchema = z.object({
   grant_types: z.array(z.string()),
   scopes: z.array(z.string()),
   confidential: z.boolean(),
-  owner_user_id: z.number(),
+  owner_user_id: z.string(),
   created_at: z.string(),
   updated_at: z.string()
 });
@@ -97,7 +97,7 @@ var OAuthConsentBodySchema = z.object({
 var OAuthAuthorizationCodeRowSchema = z.object({
   code: z.string(),
   client_id: z.string(),
-  user_id: z.number(),
+  user_id: z.string(),
   redirect_uri: z.string(),
   scope: z.string().nullable().optional(),
   code_challenge: z.string().nullable().optional(),
@@ -110,16 +110,16 @@ var OAuthAuthorizationCodeRowSchema = z.object({
 // src/core/schema/OAuthClientSchema.ts
 import { z as z2 } from "zod";
 var OAuthUserCredentialsSchema = z2.object({
-  user_id: z2.number(),
+  user_id: z2.string(),
   provider_refresh_token: z2.string().nullable().optional(),
   provider_session_token: z2.string().nullable().optional(),
   updated_at: z2.string()
 });
 var OAuthRefreshTokenSchema = z2.object({
-  id: z2.number(),
+  id: z2.string(),
   refresh_token: z2.string(),
   client_id: z2.string(),
-  user_id: z2.number(),
+  user_id: z2.string(),
   expires_at: z2.string(),
   revoked: z2.boolean(),
   created_at: z2.string()

package/dist/index.cjs

@@ -192,7 +192,7 @@ function isOAuthRedirectUri(value) {
 }
 var oauthRedirectUriSchema = import_zod.z.string().min(1).refine(isOAuthRedirectUri, { message: "Invalid redirect URI" });
 var OAuthClientRowSchema = import_zod.z.object({
-  id: import_zod.z.number(),
+  id: import_zod.z.string(),
   client_id: import_zod.z.string(),
   client_secret_hash: import_zod.z.string().nullable().optional(),
   client_name: import_zod.z.string(),
@@ -202,7 +202,7 @@ var OAuthClientRowSchema = import_zod.z.object({
   grant_types: import_zod.z.array(import_zod.z.string()),
   scopes: import_zod.z.array(import_zod.z.string()),
   confidential: import_zod.z.boolean(),
-  owner_user_id: import_zod.z.number(),
+  owner_user_id: import_zod.z.string(),
   created_at: import_zod.z.string(),
   updated_at: import_zod.z.string()
 });
@@ -275,7 +275,7 @@ var OAuthConsentBodySchema = import_zod.z.object({
 var OAuthAuthorizationCodeRowSchema = import_zod.z.object({
   code: import_zod.z.string(),
   client_id: import_zod.z.string(),
-  user_id: import_zod.z.number(),
+  user_id: import_zod.z.string(),
   redirect_uri: import_zod.z.string(),
   scope: import_zod.z.string().nullable().optional(),
   code_challenge: import_zod.z.string().nullable().optional(),
@@ -288,16 +288,16 @@ var OAuthAuthorizationCodeRowSchema = import_zod.z.object({
 // src/core/schema/OAuthClientSchema.ts
 var import_zod2 = require("zod");
 var OAuthUserCredentialsSchema = import_zod2.z.object({
-  user_id: import_zod2.z.number(),
+  user_id: import_zod2.z.string(),
   provider_refresh_token: import_zod2.z.string().nullable().optional(),
   provider_session_token: import_zod2.z.string().nullable().optional(),
   updated_at: import_zod2.z.string()
 });
 var OAuthRefreshTokenSchema = import_zod2.z.object({
-  id: import_zod2.z.number(),
+  id: import_zod2.z.string(),
   refresh_token: import_zod2.z.string(),
   client_id: import_zod2.z.string(),
-  user_id: import_zod2.z.number(),
+  user_id: import_zod2.z.string(),
   expires_at: import_zod2.z.string(),
   revoked: import_zod2.z.boolean(),
   created_at: import_zod2.z.string()

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { OAuthClientsInterface, OAuthClientsRepositoryInterface, OAuthClientList
 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 { EncryptorInterface, ExecutorError } from '@qlover/fe-corekit';
 import 'zod';
+import '@qlover/corekit-bridge/core';
 
 /**
  * Business logic for OAuth client management in developer console.
@@ -13,32 +14,32 @@ declare class OAuthClientsService implements OAuthClientsInterface {
      * List all OAuth clients owned by a user
      * @override
      */
-    listForOwner(ownerUserId: number): Promise<OAuthClientListItem[]>;
+    listForOwner(ownerUserId: string): Promise<OAuthClientListItem[]>;
     /**
      * Get detailed information about a specific OAuth client
      * @override
      */
-    getByClientId(ownerUserId: number, clientId: string): Promise<OAuthClientDetail>;
+    getByClientId(ownerUserId: string, clientId: string): Promise<OAuthClientDetail>;
     /**
      * Create a new OAuth client
      * @override
      */
-    create(ownerUserId: number, input: OAuthClientCreate): Promise<OAuthClientCreateResponse>;
+    create(ownerUserId: string, input: OAuthClientCreate): Promise<OAuthClientCreateResponse>;
     /**
      * Update an existing OAuth client
      * @override
      */
-    update(ownerUserId: number, clientId: string, input: OAuthClientUpdate): Promise<OAuthClientDetail>;
+    update(ownerUserId: string, clientId: string, input: OAuthClientUpdate): Promise<OAuthClientDetail>;
     /**
      * Rotate the client secret
      * @override
      */
-    rotateSecret(ownerUserId: number, clientId: string): Promise<OAuthClientSecretRotateResponse>;
+    rotateSecret(ownerUserId: string, clientId: string): Promise<OAuthClientSecretRotateResponse>;
     /**
      * Delete an OAuth client
      * @override
      */
-    delete(ownerUserId: number, clientId: string): Promise<void>;
+    delete(ownerUserId: string, clientId: string): Promise<void>;
     private mapToDetail;
 }
 
@@ -74,11 +75,11 @@ declare class OAuthTokenService implements OAuthTokenServiceInterface {
     protected exchangeRefreshToken(request: Extract<OAuthTokenRequest, {
         grant_type: 'refresh_token';
     }>, verifiedClientId: string): Promise<OAuthTokenResponse>;
-    protected fetchProviderAccessToken(userId: number): Promise<{
+    protected fetchProviderAccessToken(userId: string): Promise<{
         access_token: string;
         expires_in: number;
     }>;
-    protected issueMiddlewareRefreshToken(clientId: string, userId: number): Promise<string>;
+    protected issueMiddlewareRefreshToken(clientId: string, userId: string): Promise<string>;
     /**
      * @override
      * RFC 7009 — revoke middleware refresh tokens. Idempotent: unknown tokens are ignored.
@@ -135,7 +136,7 @@ declare class OAuthWrapperService<SessionPayload extends OAuthSessionPayload = O
     /**
      * @override
      */
-    logoutUser(userId: number): Promise<void>;
+    logoutUser(userId: string): Promise<void>;
     /**
      * @override
      */

package/dist/index.js

@@ -127,7 +127,7 @@ function isOAuthRedirectUri(value) {
 }
 var oauthRedirectUriSchema = z.string().min(1).refine(isOAuthRedirectUri, { message: "Invalid redirect URI" });
 var OAuthClientRowSchema = z.object({
-  id: z.number(),
+  id: z.string(),
   client_id: z.string(),
   client_secret_hash: z.string().nullable().optional(),
   client_name: z.string(),
@@ -137,7 +137,7 @@ var OAuthClientRowSchema = z.object({
   grant_types: z.array(z.string()),
   scopes: z.array(z.string()),
   confidential: z.boolean(),
-  owner_user_id: z.number(),
+  owner_user_id: z.string(),
   created_at: z.string(),
   updated_at: z.string()
 });
@@ -210,7 +210,7 @@ var OAuthConsentBodySchema = z.object({
 var OAuthAuthorizationCodeRowSchema = z.object({
   code: z.string(),
   client_id: z.string(),
-  user_id: z.number(),
+  user_id: z.string(),
   redirect_uri: z.string(),
   scope: z.string().nullable().optional(),
   code_challenge: z.string().nullable().optional(),
@@ -223,16 +223,16 @@ var OAuthAuthorizationCodeRowSchema = z.object({
 // src/core/schema/OAuthClientSchema.ts
 import { z as z2 } from "zod";
 var OAuthUserCredentialsSchema = z2.object({
-  user_id: z2.number(),
+  user_id: z2.string(),
   provider_refresh_token: z2.string().nullable().optional(),
   provider_session_token: z2.string().nullable().optional(),
   updated_at: z2.string()
 });
 var OAuthRefreshTokenSchema = z2.object({
-  id: z2.number(),
+  id: z2.string(),
   refresh_token: z2.string(),
   client_id: z2.string(),
-  user_id: z2.number(),
+  user_id: z2.string(),
   expires_at: z2.string(),
   revoked: z2.boolean(),
   created_at: z2.string()

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@qlover/oauth-wrapper",
   "description": "Provider-agnostic OAuth 2.0 authorization server core (authorization code, PKCE, token exchange, userinfo)",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "private": false,
   "sideEffects": false,
@@ -53,8 +53,8 @@
   },
   "dependencies": {
     "@qlover/fe-corekit": "3.3.0",
-    "@qlover/logger": "1.2.0",
-    "@qlover/corekit-bridge": "3.2.0"
+    "@qlover/corekit-bridge": "3.2.1",
+    "@qlover/logger": "1.2.0"
   },
   "peerDependencies": {
     "zod": "^3.0.0 || ^4.0.0"