binoauth 0.0.11 → 0.0.13

package/dist/core/src/auth/client.d.ts

@@ -0,0 +1,330 @@
+/**
+ * Unified BinoAuth authentication client
+ *
+ * Provides a single interface for all authentication methods including
+ * OAuth, password, magic link, OTP, MFA, and social authentication.
+ */
+import type { BinoAuthConfig, LoginRequest, SignupRequest, AuthResult, User, PasswordResetRequest, PasswordResetData, SocialProvider, MFAMethod } from "./types";
+import { BinoAuthOAuth } from "../oauth/client";
+import { PasswordFlow } from "./flows/password";
+import { MagicLinkFlow } from "./flows/magic-link";
+import { OTPFlow } from "./flows/otp";
+import { MFAFlow } from "./flows/mfa";
+import { SocialFlow } from "./flows/social";
+/**
+ * Unified BinoAuth authentication client
+ *
+ * Provides a comprehensive authentication solution with multiple flows
+ * and methods. This is the main entry point for most authentication needs.
+ *
+ * @example
+ * ```typescript
+ * import { BinoAuthClient } from 'binoauth';
+ *
+ * const auth = new BinoAuthClient({
+ *   issuer: 'https://auth.binoauth.com',
+ *   clientId: 'your_client_id',
+ *   redirectUri: 'https://yourapp.com/callback',
+ *   apiKey: 'your_api_key'
+ * });
+ *
+ * // Password authentication
+ * const result = await auth.loginWithPassword('user@example.com', 'password123');
+ *
+ * // Magic link authentication
+ * await auth.sendMagicLink('user@example.com', 'https://yourapp.com/dashboard');
+ *
+ * // OAuth authentication
+ * const oauthUrl = await auth.getOAuthLoginUrl();
+ * window.location.href = oauthUrl;
+ *
+ * // Social authentication
+ * const googleUrl = await auth.getSocialLoginUrl('google');
+ * window.location.href = googleUrl;
+ * ```
+ */
+export declare class BinoAuthClient {
+    private config;
+    readonly oauth: BinoAuthOAuth;
+    readonly password: PasswordFlow;
+    readonly magicLink: MagicLinkFlow;
+    readonly otp: OTPFlow;
+    readonly mfa: MFAFlow;
+    readonly social: SocialFlow;
+    /**
+     * Creates a new BinoAuth client instance
+     *
+     * @param config - BinoAuth configuration
+     *
+     * @example
+     * ```typescript
+     * // Minimal configuration
+     * const auth = new BinoAuthClient({
+     *   issuer: 'https://auth.binoauth.com',
+     *   clientId: 'your_client_id'
+     * });
+     *
+     * // Full configuration
+     * const auth = new BinoAuthClient({
+     *   issuer: 'https://auth.binoauth.com',
+     *   clientId: 'your_client_id',
+     *   redirectUri: 'https://yourapp.com/callback',
+     *   scope: 'openid profile email',
+     *   apiKey: 'your_api_key',
+     *   tenant: 'your_tenant_id',
+     *   enableMFA: true
+     * });
+     * ```
+     */
+    constructor(config: BinoAuthConfig);
+    /**
+     * Validates the client configuration
+     *
+     * @throws {AuthError} When configuration is invalid
+     */
+    private validateConfig;
+    /**
+     * Generates a default encryption key for token storage
+     *
+     * @returns Encryption key
+     */
+    private generateEncryptionKey;
+    /**
+     * Authenticates a user with email and password
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @param rememberMe - Whether to remember the user
+     * @returns Promise resolving to authentication result
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const result = await auth.loginWithPassword(
+     *     'user@example.com',
+     *     'password123',
+     *     true // remember me
+     *   );
+     *
+     *   if (result.success) {
+     *     console.log('Login successful:', result.user);
+     *   }
+     * } catch (error) {
+     *   if (error.code === AuthErrorCode.MFA_REQUIRED) {
+     *     // Handle MFA challenge
+     *     const challenge = error.details.mfaChallenge;
+     *     await auth.sendMFAChallenge(challenge.challengeId, 'sms');
+     *   }
+     * }
+     * ```
+     */
+    loginWithPassword(email: string, password: string, rememberMe?: boolean): Promise<AuthResult>;
+    /**
+     * Authenticates a user with credentials object
+     *
+     * @param credentials - Login credentials
+     * @returns Promise resolving to authentication result
+     */
+    loginWithCredentials(credentials: LoginRequest): Promise<AuthResult>;
+    /**
+     * Registers a new user account
+     *
+     * @param userData - User registration data
+     * @returns Promise resolving to authentication result
+     *
+     * @example
+     * ```typescript
+     * const result = await auth.register({
+     *   email: 'newuser@example.com',
+     *   password: 'securepassword123',
+     *   name: 'John Doe',
+     *   acceptTerms: true
+     * });
+     * ```
+     */
+    register(userData: SignupRequest): Promise<AuthResult>;
+    /**
+     * Sends a magic link to the user's email
+     *
+     * @param email - User's email address
+     * @param returnTo - URL to redirect to after authentication
+     * @returns Promise resolving when magic link is sent
+     *
+     * @example
+     * ```typescript
+     * await auth.sendMagicLink('user@example.com', 'https://myapp.com/dashboard');
+     * console.log('Magic link sent! Check your email.');
+     * ```
+     */
+    sendMagicLink(email: string, returnTo?: string): Promise<void>;
+    /**
+     * Verifies a magic link token
+     *
+     * @param token - Magic link token
+     * @returns Promise resolving to authentication result
+     */
+    verifyMagicLink(token: string): Promise<AuthResult>;
+    /**
+     * Sends an OTP to the user's email
+     *
+     * @param email - User's email address
+     * @returns Promise resolving when OTP is sent
+     *
+     * @example
+     * ```typescript
+     * await auth.sendEmailOTP('user@example.com');
+     * console.log('Verification code sent to your email');
+     * ```
+     */
+    /**
+     * Note: Email OTP is not supported. Use sendPhoneOTP instead.
+     * @deprecated Use sendPhoneOTP for SMS OTP
+     */
+    sendEmailOTP(email: string): Promise<void>;
+    /**
+     * Sends an OTP to the user's phone
+     *
+     * @param phone - User's phone number
+     * @returns Promise resolving when OTP is sent
+     *
+     * @example
+     * ```typescript
+     * await auth.sendPhoneOTP('+1234567890');
+     * console.log('Verification code sent to your phone');
+     * ```
+     */
+    sendPhoneOTP(phone: string): Promise<void>;
+    /**
+     * Verifies an OTP code
+     *
+     * @param code - OTP code
+     * @param method - OTP method ('email' or 'sms')
+     * @returns Promise resolving to authentication result
+     *
+     * @example
+     * ```typescript
+     * const result = await auth.verifyOTP('123456', 'email');
+     * if (result.success) {
+     *   console.log('OTP verification successful');
+     * }
+     * ```
+     */
+    verifyOTP(code: string): Promise<AuthResult>;
+    /**
+     * Gets the OAuth authorization URL
+     *
+     * @returns Promise resolving to authorization URL
+     *
+     * @example
+     * ```typescript
+     * const oauthUrl = await auth.getOAuthLoginUrl();
+     * window.location.href = oauthUrl;
+     * ```
+     */
+    getOAuthLoginUrl(): Promise<string>;
+    /**
+     * Handles OAuth callback
+     *
+     * @param code - Authorization code
+     * @param state - State parameter
+     * @returns Promise resolving when callback is handled
+     */
+    handleOAuthCallback(code: string, state: string): Promise<void>;
+    /**
+     * Gets social login URL for a provider
+     *
+     * @param provider - Social provider
+     * @param request - Optional social auth request
+     * @returns Promise resolving to authorization URL
+     *
+     * @example
+     * ```typescript
+     * const googleUrl = await auth.getSocialLoginUrl('google', {
+     *   returnTo: 'https://myapp.com/dashboard'
+     * });
+     * window.location.href = googleUrl;
+     * ```
+     */
+    getSocialLoginUrl(provider: SocialProvider, returnTo: string, redirectUri?: string): Promise<string>;
+    /**
+     * Handles social authentication callback
+     *
+     * @param provider - Social provider
+     * @param code - Authorization code
+     * @param state - State parameter
+     * @returns Promise resolving to authentication result
+     */
+    handleSocialCallback(provider: SocialProvider, code: string, state: string, link?: boolean): Promise<AuthResult>;
+    /**
+     * Sends an MFA challenge
+     *
+     * @param challengeId - MFA challenge ID
+     * @param method - MFA method
+     * @returns Promise resolving when challenge is sent
+     */
+    /**
+     * Note: MFA challenge sending is not available in current tenant-sdk.
+     * @deprecated Use verifyMFA instead
+     */
+    sendMFAChallenge(challengeId: string, method: MFAMethod): Promise<void>;
+    /**
+     * Verifies an MFA challenge
+     *
+     * @param challengeId - MFA challenge ID
+     * @param code - Verification code
+     * @param method - MFA method
+     * @returns Promise resolving to authentication result
+     */
+    verifyMFA(code: string, sessionId: string): Promise<AuthResult>;
+    /**
+     * Requests password reset
+     *
+     * @param request - Password reset request
+     * @returns Promise resolving when reset request is sent
+     */
+    requestPasswordReset(request: PasswordResetRequest): Promise<void>;
+    /**
+     * Resets password with token
+     *
+     * @param resetData - Password reset data
+     * @returns Promise resolving to authentication result
+     */
+    resetPassword(resetData: PasswordResetData): Promise<AuthResult>;
+    /**
+     * Gets current access token
+     *
+     * @returns Promise resolving to access token or null
+     */
+    getAccessToken(): Promise<string | null>;
+    /**
+     * Checks if user is authenticated
+     *
+     * @returns Promise resolving to authentication status
+     */
+    isAuthenticated(): Promise<boolean>;
+    /**
+     * Gets current user information
+     *
+     * @returns Promise resolving to user info or null
+     */
+    getUserInfo(): Promise<User | null>;
+    /**
+     * Refreshes access tokens
+     *
+     * @returns Promise resolving when tokens are refreshed
+     */
+    refreshTokens(): Promise<void>;
+    /**
+     * Logs out the user
+     *
+     * @returns Promise resolving when logout is complete
+     */
+    logout(): Promise<void>;
+    /**
+     * Gets logout URL
+     *
+     * @returns Promise resolving to logout URL
+     */
+    getLogoutUrl(): Promise<string>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/core/src/auth/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/auth/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,aAAa,EACb,UAAU,EACV,IAAI,EAGJ,oBAAoB,EACpB,iBAAiB,EACjB,cAAc,EAEd,SAAS,EAEV,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,cAAc;IAkCb,OAAO,CAAC,MAAM;IAhC1B,SAAgB,KAAK,EAAE,aAAa,CAAC;IACrC,SAAgB,QAAQ,EAAE,YAAY,CAAC;IACvC,SAAgB,SAAS,EAAE,aAAa,CAAC;IACzC,SAAgB,GAAG,EAAE,OAAO,CAAC;IAC7B,SAAgB,GAAG,EAAE,OAAO,CAAC;IAC7B,SAAgB,MAAM,EAAE,UAAU,CAAC;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;gBACiB,MAAM,EAAE,cAAc;IAwB1C;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAgBtB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAO7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;IAInG;;;;;OAKG;IACG,oBAAoB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAI1E;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC;IAI5D;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpE;;;;;OAKG;IACG,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIzD;;;;;;;;;;;OAWG;IACH;;;OAGG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOhD;;;;;;;;;;;OAWG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD;;;;;;;;;;;;;;OAcG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlD;;;;;;;;;;OAUG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIzC;;;;;;OAMG;IACG,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE;;;;;;;;;;;;;;OAcG;IACG,iBAAiB,CAAC,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1G;;;;;;;OAOG;IACG,oBAAoB,CAAC,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;IAItH;;;;;;OAMG;IACH;;;OAGG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7E;;;;;;;OAOG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAIrE;;;;;OAKG;IACG,oBAAoB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxE;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC;IAItE;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAI9C;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAIzC;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAKzC;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAIpC;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;CAGtC"}