@classic-homes/auth 0.1.22 → 0.1.24

package/dist/config-C-iBNu07.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Auth Configuration
+ *
+ * Manages global configuration for the auth package.
+ * Must be initialized via initAuth() before using auth services.
+ */
+interface SSOConfig {
+    /** Whether SSO is enabled */
+    enabled: boolean;
+    /** SSO provider name (e.g., 'authentik', 'okta') */
+    provider: string;
+    /** Override the default authorize URL (defaults to /auth/sso/authorize) */
+    authorizeUrl?: string;
+}
+interface StorageAdapter {
+    getItem(key: string): string | null;
+    setItem(key: string, value: string): void;
+    removeItem(key: string): void;
+}
+interface AuthConfig {
+    /** Base URL for the API (e.g., 'https://api.example.com/v1') */
+    baseUrl: string;
+    /** Custom fetch implementation (useful for SSR or testing) */
+    fetch?: typeof fetch;
+    /** Storage adapter for token persistence (defaults to localStorage in browser) */
+    storage?: StorageAdapter;
+    /** Storage key prefix for auth data */
+    storageKey?: string;
+    /** Callback when auth errors occur (e.g., for logging or analytics) */
+    onAuthError?: (error: Error) => void;
+    /** Callback when tokens are refreshed */
+    onTokenRefresh?: (tokens: {
+        accessToken: string;
+        refreshToken: string;
+    }) => void;
+    /** Callback when user is logged out (e.g., for redirect) */
+    onLogout?: () => void;
+    /** SSO configuration */
+    sso?: SSOConfig;
+}
+/**
+ * Initialize the auth package with configuration.
+ * Must be called before using any auth services.
+ *
+ * @example
+ * ```typescript
+ * import { initAuth } from '@classic-homes/auth';
+ *
+ * initAuth({
+ *   baseUrl: import.meta.env.PUBLIC_API_URL,
+ *   sso: {
+ *     enabled: true,
+ *     provider: 'authentik',
+ *   },
+ * });
+ * ```
+ */
+declare function initAuth(options: AuthConfig): void;
+/**
+ * Get the current auth configuration.
+ * Throws if initAuth() has not been called.
+ */
+declare function getConfig(): AuthConfig;
+/**
+ * Check if auth has been initialized.
+ */
+declare function isInitialized(): boolean;
+/**
+ * Reset the auth configuration (useful for testing).
+ */
+declare function resetConfig(): void;
+/**
+ * Get the default storage adapter.
+ * Returns localStorage in browser, or a no-op adapter in SSR.
+ */
+declare function getDefaultStorage(): StorageAdapter;
+/**
+ * Get the storage adapter from config or use default.
+ */
+declare function getStorage(): StorageAdapter;
+/**
+ * Get the fetch implementation from config or use global fetch.
+ */
+declare function getFetch(): typeof fetch;
+
+export { type AuthConfig as A, type SSOConfig as S, isInitialized as a, getDefaultStorage as b, getStorage as c, getFetch as d, type StorageAdapter as e, getConfig as g, initAuth as i, resetConfig as r };

package/dist/core/index.d.ts

@@ -1,90 +1,6 @@
-import { L as LoginCredentials, a as LoginResponse, R as RegisterData, b as RegisterResponse, U as User, j as ProfileUpdateData, k as ChangePasswordData, S as Session, c as ApiKey, C as CreateApiKeyRequest, d as CreateApiKeyResponse, e as MFAStatus, M as MFASetupResponse, f as MFAChallengeData, D as Device, g as UserPreferences, h as LinkedAccount, i as SecurityEvent, P as Pagination } from '../types-exFUQyBX.js';
-export { A as AuthState, l as ResetPasswordData } from '../types-exFUQyBX.js';
-
-/**
- * Auth Configuration
- *
- * Manages global configuration for the auth package.
- * Must be initialized via initAuth() before using auth services.
- */
-interface SSOConfig {
-    /** Whether SSO is enabled */
-    enabled: boolean;
-    /** SSO provider name (e.g., 'authentik', 'okta') */
-    provider: string;
-    /** Override the default authorize URL (defaults to /auth/sso/authorize) */
-    authorizeUrl?: string;
-}
-interface StorageAdapter {
-    getItem(key: string): string | null;
-    setItem(key: string, value: string): void;
-    removeItem(key: string): void;
-}
-interface AuthConfig {
-    /** Base URL for the API (e.g., 'https://api.example.com/v1') */
-    baseUrl: string;
-    /** Custom fetch implementation (useful for SSR or testing) */
-    fetch?: typeof fetch;
-    /** Storage adapter for token persistence (defaults to localStorage in browser) */
-    storage?: StorageAdapter;
-    /** Storage key prefix for auth data */
-    storageKey?: string;
-    /** Callback when auth errors occur (e.g., for logging or analytics) */
-    onAuthError?: (error: Error) => void;
-    /** Callback when tokens are refreshed */
-    onTokenRefresh?: (tokens: {
-        accessToken: string;
-        refreshToken: string;
-    }) => void;
-    /** Callback when user is logged out (e.g., for redirect) */
-    onLogout?: () => void;
-    /** SSO configuration */
-    sso?: SSOConfig;
-}
-/**
- * Initialize the auth package with configuration.
- * Must be called before using any auth services.
- *
- * @example
- * ```typescript
- * import { initAuth } from '@classic-homes/auth';
- *
- * initAuth({
- *   baseUrl: import.meta.env.PUBLIC_API_URL,
- *   sso: {
- *     enabled: true,
- *     provider: 'authentik',
- *   },
- * });
- * ```
- */
-declare function initAuth(options: AuthConfig): void;
-/**
- * Get the current auth configuration.
- * Throws if initAuth() has not been called.
- */
-declare function getConfig(): AuthConfig;
-/**
- * Check if auth has been initialized.
- */
-declare function isInitialized(): boolean;
-/**
- * Reset the auth configuration (useful for testing).
- */
-declare function resetConfig(): void;
-/**
- * Get the default storage adapter.
- * Returns localStorage in browser, or a no-op adapter in SSR.
- */
-declare function getDefaultStorage(): StorageAdapter;
-/**
- * Get the storage adapter from config or use default.
- */
-declare function getStorage(): StorageAdapter;
-/**
- * Get the fetch implementation from config or use global fetch.
- */
-declare function getFetch(): typeof fetch;
+export { A as AuthConfig, S as SSOConfig, e as StorageAdapter, g as getConfig, b as getDefaultStorage, d as getFetch, c as getStorage, i as initAuth, a as isInitialized, r as resetConfig } from '../config-C-iBNu07.js';
+import { L as LoginCredentials, a as LoginResponse, b as LogoutResponse, R as RegisterData, c as RegisterResponse, U as User, k as ProfileUpdateData, l as ChangePasswordData, S as Session, d as ApiKey, C as CreateApiKeyRequest, e as CreateApiKeyResponse, f as MFAStatus, M as MFASetupResponse, g as MFAChallengeData, D as Device, h as UserPreferences, i as LinkedAccount, j as SecurityEvent, P as Pagination } from '../types-DGN45Uih.js';
+export { A as AuthState, m as ResetPasswordData } from '../types-DGN45Uih.js';
 
 /**
  * HTTP Client
@@ -125,6 +41,7 @@ declare function getRefreshToken(): string | null;
 declare function getSessionToken(): string | null;
 /**
  * Update stored tokens.
+ * Also updates the Svelte auth store if available.
  */
 declare function updateStoredTokens(accessToken: string, refreshToken: string): void;
 /**
@@ -167,8 +84,9 @@ declare const authApi: {
     login(credentials: LoginCredentials): Promise<LoginResponse>;
     /**
      * Logout the current user.
+     * Returns SSO logout URL if applicable for SSO users.
      */
-    logout(): Promise<void>;
+    logout(): Promise<LogoutResponse>;
     /**
      * Register a new user.
      */
@@ -190,8 +108,13 @@ declare const authApi: {
     }>;
     /**
      * Initiate SSO login by redirecting to the SSO provider.
+     * @param options.callbackUrl - The URL where the SSO provider should redirect after auth
+     * @param options.redirectUrl - The final URL to redirect to after processing the callback
      */
-    initiateSSOLogin(): void;
+    initiateSSOLogin(options?: {
+        callbackUrl?: string;
+        redirectUrl?: string;
+    }): void;
     /**
      * Get the current user's profile.
      */
@@ -348,6 +271,22 @@ declare const authApi: {
  * Wraps authApi calls and provides a clean interface for components.
  */
 
+interface LoginOptions {
+    /**
+     * Automatically update the auth store after successful login.
+     * Set to false to manually handle auth state.
+     * @default true
+     */
+    autoSetAuth?: boolean;
+}
+interface MFAVerifyOptions {
+    /**
+     * Automatically update the auth store after successful MFA verification.
+     * Set to false to manually handle auth state.
+     * @default true
+     */
+    autoSetAuth?: boolean;
+}
 /**
  * AuthService
  *
@@ -357,12 +296,16 @@ declare const authApi: {
 declare class AuthService {
     /**
      * Login with username and password.
+     * By default, automatically sets the auth state on successful login (unless MFA is required).
+     * @param credentials - Username and password
+     * @param options - Optional settings for login behavior
      */
-    login(credentials: LoginCredentials): Promise<LoginResponse>;
+    login(credentials: LoginCredentials, options?: LoginOptions): Promise<LoginResponse>;
     /**
      * Logout the current user.
+     * Returns SSO logout URL if applicable for SSO users.
      */
-    logout(): Promise<void>;
+    logout(): Promise<LogoutResponse>;
     /**
      * Register a new user.
      */
@@ -388,8 +331,13 @@ declare class AuthService {
     }>;
     /**
      * Initiate SSO login (redirects to SSO provider).
+     * @param options.callbackUrl - The URL where the SSO provider should redirect after auth
+     * @param options.redirectUrl - The final URL to redirect to after processing the callback
      */
-    initiateSSOLogin(): void;
+    initiateSSOLogin(options?: {
+        callbackUrl?: string;
+        redirectUrl?: string;
+    }): void;
     /**
      * Get the current user's profile.
      */
@@ -466,8 +414,11 @@ declare class AuthService {
     }>;
     /**
      * Verify MFA challenge during login.
+     * By default, automatically sets the auth state on successful verification.
+     * @param data - MFA challenge data including token and code
+     * @param options - Optional settings for verification behavior
      */
-    verifyMFAChallenge(data: MFAChallengeData): Promise<LoginResponse>;
+    verifyMFAChallenge(data: MFAChallengeData, options?: MFAVerifyOptions): Promise<LoginResponse>;
     /**
      * Get all devices.
      */
@@ -535,6 +486,33 @@ declare class AuthService {
 /** Singleton instance of AuthService */
 declare const authService: AuthService;
 
+/**
+ * Auth Guards
+ *
+ * Type guards and utility functions for checking authentication response types.
+ */
+
+/**
+ * Check if a login response requires MFA verification.
+ * Returns true if the response indicates MFA is required.
+ */
+declare function isMfaChallengeResponse(response: LoginResponse): boolean;
+/**
+ * Check if a login response is a successful login (with tokens and user).
+ * Returns true if the response contains valid authentication data.
+ */
+declare function isLoginSuccessResponse(response: LoginResponse): boolean;
+/**
+ * Extract the MFA token from a login response.
+ * Returns the MFA challenge token or undefined if not present.
+ */
+declare function getMfaToken(response: LoginResponse): string | undefined;
+/**
+ * Get available MFA methods from a login response.
+ * Returns the list of available methods or defaults to ['totp'].
+ */
+declare function getAvailableMethods(response: LoginResponse): string[];
+
 /**
  * JWT Utilities
  *
@@ -628,4 +606,4 @@ declare function getTokenExpiration(token: string): Date | null;
  */
 declare function extractClaims<T extends string>(token: string, claims: T[]): Pick<JWTPayload, T> | null;
 
-export { ApiKey, type ApiRequestOptions, type ApiResponse, type AuthConfig, AuthService, ChangePasswordData, CreateApiKeyRequest, CreateApiKeyResponse, Device, type JWTPayload, LinkedAccount, LoginCredentials, LoginResponse, MFAChallengeData, MFASetupResponse, MFAStatus, Pagination, ProfileUpdateData, RegisterData, RegisterResponse, type SSOConfig, SecurityEvent, Session, type StorageAdapter, User, UserPreferences, api, apiRequest, authApi, authService, clearStoredAuth, decodeJWT, extractClaims, extractData, getAccessToken, getConfig, getDefaultStorage, getFetch, getRefreshToken, getSessionToken, getStorage, getTokenExpiration, getTokenRemainingTime, initAuth, isInitialized, isTokenExpired, resetConfig, updateStoredTokens };
+export { ApiKey, type ApiRequestOptions, type ApiResponse, AuthService, ChangePasswordData, CreateApiKeyRequest, CreateApiKeyResponse, Device, type JWTPayload, LinkedAccount, LoginCredentials, type LoginOptions, LoginResponse, LogoutResponse, MFAChallengeData, MFASetupResponse, MFAStatus, type MFAVerifyOptions, Pagination, ProfileUpdateData, RegisterData, RegisterResponse, SecurityEvent, Session, User, UserPreferences, api, apiRequest, authApi, authService, clearStoredAuth, decodeJWT, extractClaims, extractData, getAccessToken, getAvailableMethods, getMfaToken, getRefreshToken, getSessionToken, getTokenExpiration, getTokenRemainingTime, isLoginSuccessResponse, isMfaChallengeResponse, isTokenExpired, updateStoredTokens };