@qlover/oauth-wrapper 0.2.3 → 0.3.0

package/dist/core.cjs

@@ -44,7 +44,9 @@ __export(core_exports, {
   computePkceS256Challenge: () => computePkceS256Challenge,
   generatePkceVerifier: () => generatePkceVerifier,
   isOAuthRedirectUri: () => isOAuthRedirectUri,
-  randomOAuthState: () => randomOAuthState
+  randomOAuthState: () => randomOAuthState,
+  signWithEmailOtpSchema: () => signWithEmailOtpSchema,
+  signWithPhoneOtpSchema: () => signWithPhoneOtpSchema
 });
 module.exports = __toCommonJS(core_exports);
 
@@ -156,6 +158,18 @@ var OAuthAuthorizationCodeRowSchema = import_zod.z.object({
   used: import_zod.z.boolean(),
   created_at: import_zod.z.string()
 });
+var signWithPhoneOtpSchema = import_zod.z.object({
+  /** The user's phone number. */
+  phone: import_zod.z.string(),
+  /** The otp sent to the user's phone number. */
+  token: import_zod.z.string().optional()
+});
+var signWithEmailOtpSchema = import_zod.z.object({
+  /** The user's email address. */
+  email: import_zod.z.email(),
+  /** The otp sent to the user's email address. */
+  token: import_zod.z.string().optional()
+});
 
 // src/core/schema/OAuthClientSchema.ts
 var import_zod2 = require("zod");
@@ -297,5 +311,7 @@ function randomOAuthState() {
   computePkceS256Challenge,
   generatePkceVerifier,
   isOAuthRedirectUri,
-  randomOAuthState
+  randomOAuthState,
+  signWithEmailOtpSchema,
+  signWithPhoneOtpSchema
 });

package/dist/core.d.ts

@@ -111,6 +111,17 @@ declare const OAuthAuthorizationCodeRowSchema: z.ZodObject<{
     created_at: z.ZodString;
 }, z.core.$strip>;
 type OAuthAuthorizationCodeRow = z.infer<typeof OAuthAuthorizationCodeRowSchema>;
+declare const signWithPhoneOtpSchema: z.ZodObject<{
+    phone: z.ZodString;
+    token: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const signWithEmailOtpSchema: z.ZodObject<{
+    email: z.ZodEmail;
+    token: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type SignWithPhoneOtpSchema = z.infer<typeof signWithPhoneOtpSchema>;
+type SignWithEmailOtpSchema = z.infer<typeof signWithEmailOtpSchema>;
+type SignWithOtpSchema = SignWithPhoneOtpSchema | SignWithEmailOtpSchema;
 
 interface OAuthClientsInterface {
     listForOwner(ownerUserId: string): Promise<OAuthClientListItem[]>;
@@ -352,6 +363,53 @@ interface OAuthProviderInterface<SessionPayload extends OAuthSessionPayload> ext
     processConsent(requestBody: unknown): Promise<OAuthConsentResult>;
     getUserInfoWithAccessToken(accessToken: string): Promise<OAuthUserInfoResponse>;
 }
+type SignWithOtpParams = {
+    email: string;
+} | {
+    phone: string;
+};
+interface VerifyMobileOtpParams {
+    /** The user's phone number. */
+    phone: string;
+    /** The otp sent to the user's phone number. */
+    token: string;
+}
+interface VerifyEmailOtpParams {
+    /** The user's email address. */
+    email: string;
+    /** The otp sent to the user's email address. */
+    token: string;
+}
+type VerifyOtpParams = SignWithOtpSchema;
+type SignOtpResult = {
+    expired: number;
+    messageId?: string;
+};
+/**
+ * Interface for OAuth providers that support OTP-based authentication.
+ *
+ * This interface extends the base OAuthProviderInterface with methods specific to OTP flows.
+ * It allows for signing in with OTP and verifying OTP tokens to establish sessions.
+ *
+ * The generic SessionPayload type parameter allows implementations to define their own session data structure.
+ */
+interface OAuthOTPProviderInterface {
+    /**
+     * Sign in using OTP. The params can be either email-based or phone-based.
+     * The implementation should handle sending the OTP to the user.
+     *
+     * @param params - Parameters for signing in with OTP, either email or phone.
+     * @returns A promise that resolves to the session payload after successful OTP initiation.
+     */
+    signWithOtp(params: SignWithOtpParams): Promise<SignOtpResult>;
+    /**
+     * Verify the OTP token provided by the user. This method should validate the OTP and establish a session if valid.
+     *
+     * @param params - Parameters for verifying the OTP, including the identifier (email or phone) and the OTP token.
+     * @returns A promise that resolves to the session payload after successful OTP verification.
+     */
+    verifyOtp(params: VerifyOtpParams): Promise<SignOtpResult>;
+}
 
 declare const OAuthRfcCodes: {
     readonly INVALID_REQUEST: "invalid_request";
@@ -375,4 +433,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 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, computePkceS256Challenge, generatePkceVerifier, isOAuthRedirectUri, randomOAuthState };
+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 };

package/dist/core.js

@@ -106,6 +106,18 @@ var OAuthAuthorizationCodeRowSchema = z.object({
   used: z.boolean(),
   created_at: z.string()
 });
+var signWithPhoneOtpSchema = z.object({
+  /** The user's phone number. */
+  phone: z.string(),
+  /** The otp sent to the user's phone number. */
+  token: z.string().optional()
+});
+var signWithEmailOtpSchema = z.object({
+  /** The user's email address. */
+  email: z.email(),
+  /** The otp sent to the user's email address. */
+  token: z.string().optional()
+});
 
 // src/core/schema/OAuthClientSchema.ts
 import { z as z2 } from "zod";
@@ -246,5 +258,7 @@ export {
   computePkceS256Challenge,
   generatePkceVerifier,
   isOAuthRedirectUri,
-  randomOAuthState
+  randomOAuthState,
+  signWithEmailOtpSchema,
+  signWithPhoneOtpSchema
 };

package/dist/index.cjs

@@ -58,6 +58,8 @@ __export(server_exports, {
   normalizeQuery: () => normalizeQuery,
   parseScopeList: () => parseScopeList,
   randomOAuthState: () => randomOAuthState,
+  signWithEmailOtpSchema: () => signWithEmailOtpSchema,
+  signWithPhoneOtpSchema: () => signWithPhoneOtpSchema,
   validatePkceParams: () => validatePkceParams,
   verifyClientSecret: () => verifyClientSecret,
   verifyPkceS256: () => verifyPkceS256
@@ -172,6 +174,18 @@ var OAuthAuthorizationCodeRowSchema = import_zod.z.object({
   used: import_zod.z.boolean(),
   created_at: import_zod.z.string()
 });
+var signWithPhoneOtpSchema = import_zod.z.object({
+  /** The user's phone number. */
+  phone: import_zod.z.string(),
+  /** The otp sent to the user's phone number. */
+  token: import_zod.z.string().optional()
+});
+var signWithEmailOtpSchema = import_zod.z.object({
+  /** The user's email address. */
+  email: import_zod.z.email(),
+  /** The otp sent to the user's email address. */
+  token: import_zod.z.string().optional()
+});
 
 // src/core/schema/OAuthClientSchema.ts
 var import_zod2 = require("zod");
@@ -1087,6 +1101,8 @@ async function verifyClientSecret(secret, storedHash) {
   normalizeQuery,
   parseScopeList,
   randomOAuthState,
+  signWithEmailOtpSchema,
+  signWithPhoneOtpSchema,
   validatePkceParams,
   verifyClientSecret,
   verifyPkceS256

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 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, OAuthRefreshTokenRow, OAuthRefreshTokenSchema, OAuthRfcCodes, OAuthRfcErrorCodesType, OAuthTokenAuthorizationCodeRequest, OAuthTokenAuthorizationCodeSchema, OAuthTokenErrorResponse, OAuthTokenErrorResponseSchema, OAuthTokenRefreshRequest, OAuthTokenRefreshSchema, OAuthTokenRequestSchema, OAuthTokenResponseSchema, OAuthTokenRevokeRequest, OAuthTokenRevokeSchema, OAuthUserCredentialsRow, OAuthUserCredentialsSchema, OAuthUserInfoErrorResponse, OAuthUserInfoErrorResponseSchema, OAuthUserInfoResponseSchema, ResolveAuthorizePageResult, computePkceS256Challenge, generatePkceVerifier, isOAuthRedirectUri, randomOAuthState } 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';
 

package/dist/index.js

@@ -106,6 +106,18 @@ var OAuthAuthorizationCodeRowSchema = z.object({
   used: z.boolean(),
   created_at: z.string()
 });
+var signWithPhoneOtpSchema = z.object({
+  /** The user's phone number. */
+  phone: z.string(),
+  /** The otp sent to the user's phone number. */
+  token: z.string().optional()
+});
+var signWithEmailOtpSchema = z.object({
+  /** The user's email address. */
+  email: z.email(),
+  /** The otp sent to the user's email address. */
+  token: z.string().optional()
+});
 
 // src/core/schema/OAuthClientSchema.ts
 import { z as z2 } from "zod";
@@ -1020,6 +1032,8 @@ export {
   normalizeQuery,
   parseScopeList,
   randomOAuthState,
+  signWithEmailOtpSchema,
+  signWithPhoneOtpSchema,
   validatePkceParams,
   verifyClientSecret,
   verifyPkceS256

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.3",
+  "version": "0.3.0",
   "type": "module",
   "private": false,
   "sideEffects": false,
@@ -53,8 +53,8 @@
   },
   "dependencies": {
     "@qlover/fe-corekit": "3.3.0",
-    "@qlover/corekit-bridge": "3.2.1",
-    "@qlover/logger": "1.2.0"
+    "@qlover/logger": "1.2.0",
+    "@qlover/corekit-bridge": "3.2.1"
   },
   "peerDependencies": {
     "zod": "^3.0.0 || ^4.0.0"