@djangocfg/api 2.1.456 → 2.1.457

package/dist/auth.d.cts

@@ -15,10 +15,6 @@ declare const AUTH_CONSTANTS: {
     /** Backup code max length. */
     readonly BACKUP_CODE_MAX_LENGTH: 12;
 };
-/** Default route for the sign-in page. Override per app via AuthConfig.routes. */
-declare const DEFAULT_AUTH_PATH = "/auth";
-/** Default post-login destination. Override per app via AuthConfig.routes. */
-declare const DEFAULT_CALLBACK_PATH = "/dashboard";
 
 type SessionStatus = 'authenticated' | 'anonymous';
 type SessionSnapshot = {
@@ -447,11 +443,23 @@ interface AuthConfig {
     };
     onLogout?: () => void;
 }
+/**
+ * AuthConfig.routes resolved against the framework conventions — no field is
+ * optional here. This is what components consume (via `useAuth().routes`)
+ * instead of defaulting to route constants themselves.
+ */
+interface ResolvedAuthRoutes {
+    auth: string;
+    defaultCallback: string;
+    defaultAuthCallback: string;
+}
 interface AuthContextType {
     user: UserProfile | null;
     isLoading: boolean;
     isAuthenticated: boolean;
     isAdminUser: boolean;
+    /** Resolved route conventions (config override or framework default). */
+    routes: ResolvedAuthRoutes;
     loadCurrentProfile: (callerId?: string) => Promise<void>;
     checkAuthAndRedirect: () => Promise<void>;
     getToken: () => string | null;
@@ -849,6 +857,17 @@ interface AuthRedirectOptions {
     fallbackUrl?: string;
     clearOnUse?: boolean;
 }
+/**
+ * Read the saved back-url without clearing it. Null when nothing saved —
+ * unlike getFinalRedirectUrl, never substitutes a fallback.
+ */
+declare const peekSavedRedirect: () => string | null;
+/**
+ * Read AND clear the saved back-url (single-use intent). Null when nothing
+ * saved. This is the one primitive every post-auth navigator uses to honor
+ * "return the user to where the guard bounced them from".
+ */
+declare const consumeSavedRedirect: () => string | null;
 declare const useAuthRedirectManager: (options?: AuthRedirectOptions) => {
     redirectUrl: string;
     setRedirect: (url: string) => void;
@@ -1092,4 +1111,4 @@ declare const Analytics: {
     setUser(userId: string): void;
 };
 
-export { AUTH_CONSTANTS, type AccountsContextValue, AccountsProvider, Analytics, AnalyticsCategory, type AnalyticsCategoryType, AnalyticsEvent, type AnalyticsEventType, type AuthConfig, AuthContext, type AuthContextType, type AuthFormAutoSubmit, type AuthFormReturn, type AuthFormState, type AuthFormStateHandlers, type AuthFormSubmitHandlers, type AuthFormValidation, AuthProvider, type AuthProviderProps, type AuthStep, DEFAULT_AUTH_PATH, DEFAULT_CALLBACK_PATH, type DeleteAccountResult, type GuardInput, type OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, type SessionSnapshot, type SessionStatus, type TwoFactorDevice, type TwoFactorSetupData, type UseAuthFormOptions, type UseAuthFormStateReturn, type UseAutoAuthOptions, type UseDeleteAccountReturn, type UseGithubAuthOptions, type UseGithubAuthReturn, type UseTwoFactorOptions, type UseTwoFactorReturn, type UseTwoFactorSetupOptions, type UseTwoFactorSetupReturn, type UseTwoFactorStatusReturn, type UserProfile, type WebmailLink, authLogger, clearProfileCache, decodeBase64, encodeBase64, formatAuthError, getCacheMetadata, getCachedProfile, hasValidCache, isAllowedAuthPath, logger, normalizePath, resolveGuardIsAuthenticated, resolveGuardIsLoading, setCachedProfile, shouldRedirectToAuth, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSession, useSessionStorage, useTwoFactor, useTwoFactorSetup, useTwoFactorStatus, validateEmail, validateIdentifier };
+export { AUTH_CONSTANTS, type AccountsContextValue, AccountsProvider, Analytics, AnalyticsCategory, type AnalyticsCategoryType, AnalyticsEvent, type AnalyticsEventType, type AuthConfig, AuthContext, type AuthContextType, type AuthFormAutoSubmit, type AuthFormReturn, type AuthFormState, type AuthFormStateHandlers, type AuthFormSubmitHandlers, type AuthFormValidation, AuthProvider, type AuthProviderProps, type AuthStep, type DeleteAccountResult, type GuardInput, type OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, type SessionSnapshot, type SessionStatus, type TwoFactorDevice, type TwoFactorSetupData, type UseAuthFormOptions, type UseAuthFormStateReturn, type UseAutoAuthOptions, type UseDeleteAccountReturn, type UseGithubAuthOptions, type UseGithubAuthReturn, type UseTwoFactorOptions, type UseTwoFactorReturn, type UseTwoFactorSetupOptions, type UseTwoFactorSetupReturn, type UseTwoFactorStatusReturn, type UserProfile, type WebmailLink, authLogger, clearProfileCache, consumeSavedRedirect, decodeBase64, encodeBase64, formatAuthError, getCacheMetadata, getCachedProfile, hasValidCache, isAllowedAuthPath, logger, normalizePath, peekSavedRedirect, resolveGuardIsAuthenticated, resolveGuardIsLoading, setCachedProfile, shouldRedirectToAuth, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSession, useSessionStorage, useTwoFactor, useTwoFactorSetup, useTwoFactorStatus, validateEmail, validateIdentifier };

package/dist/auth.d.ts

@@ -15,10 +15,6 @@ declare const AUTH_CONSTANTS: {
     /** Backup code max length. */
     readonly BACKUP_CODE_MAX_LENGTH: 12;
 };
-/** Default route for the sign-in page. Override per app via AuthConfig.routes. */
-declare const DEFAULT_AUTH_PATH = "/auth";
-/** Default post-login destination. Override per app via AuthConfig.routes. */
-declare const DEFAULT_CALLBACK_PATH = "/dashboard";
 
 type SessionStatus = 'authenticated' | 'anonymous';
 type SessionSnapshot = {
@@ -447,11 +443,23 @@ interface AuthConfig {
     };
     onLogout?: () => void;
 }
+/**
+ * AuthConfig.routes resolved against the framework conventions — no field is
+ * optional here. This is what components consume (via `useAuth().routes`)
+ * instead of defaulting to route constants themselves.
+ */
+interface ResolvedAuthRoutes {
+    auth: string;
+    defaultCallback: string;
+    defaultAuthCallback: string;
+}
 interface AuthContextType {
     user: UserProfile | null;
     isLoading: boolean;
     isAuthenticated: boolean;
     isAdminUser: boolean;
+    /** Resolved route conventions (config override or framework default). */
+    routes: ResolvedAuthRoutes;
     loadCurrentProfile: (callerId?: string) => Promise<void>;
     checkAuthAndRedirect: () => Promise<void>;
     getToken: () => string | null;
@@ -849,6 +857,17 @@ interface AuthRedirectOptions {
     fallbackUrl?: string;
     clearOnUse?: boolean;
 }
+/**
+ * Read the saved back-url without clearing it. Null when nothing saved —
+ * unlike getFinalRedirectUrl, never substitutes a fallback.
+ */
+declare const peekSavedRedirect: () => string | null;
+/**
+ * Read AND clear the saved back-url (single-use intent). Null when nothing
+ * saved. This is the one primitive every post-auth navigator uses to honor
+ * "return the user to where the guard bounced them from".
+ */
+declare const consumeSavedRedirect: () => string | null;
 declare const useAuthRedirectManager: (options?: AuthRedirectOptions) => {
     redirectUrl: string;
     setRedirect: (url: string) => void;
@@ -1092,4 +1111,4 @@ declare const Analytics: {
     setUser(userId: string): void;
 };
 
-export { AUTH_CONSTANTS, type AccountsContextValue, AccountsProvider, Analytics, AnalyticsCategory, type AnalyticsCategoryType, AnalyticsEvent, type AnalyticsEventType, type AuthConfig, AuthContext, type AuthContextType, type AuthFormAutoSubmit, type AuthFormReturn, type AuthFormState, type AuthFormStateHandlers, type AuthFormSubmitHandlers, type AuthFormValidation, AuthProvider, type AuthProviderProps, type AuthStep, DEFAULT_AUTH_PATH, DEFAULT_CALLBACK_PATH, type DeleteAccountResult, type GuardInput, type OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, type SessionSnapshot, type SessionStatus, type TwoFactorDevice, type TwoFactorSetupData, type UseAuthFormOptions, type UseAuthFormStateReturn, type UseAutoAuthOptions, type UseDeleteAccountReturn, type UseGithubAuthOptions, type UseGithubAuthReturn, type UseTwoFactorOptions, type UseTwoFactorReturn, type UseTwoFactorSetupOptions, type UseTwoFactorSetupReturn, type UseTwoFactorStatusReturn, type UserProfile, type WebmailLink, authLogger, clearProfileCache, decodeBase64, encodeBase64, formatAuthError, getCacheMetadata, getCachedProfile, hasValidCache, isAllowedAuthPath, logger, normalizePath, resolveGuardIsAuthenticated, resolveGuardIsLoading, setCachedProfile, shouldRedirectToAuth, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSession, useSessionStorage, useTwoFactor, useTwoFactorSetup, useTwoFactorStatus, validateEmail, validateIdentifier };
+export { AUTH_CONSTANTS, type AccountsContextValue, AccountsProvider, Analytics, AnalyticsCategory, type AnalyticsCategoryType, AnalyticsEvent, type AnalyticsEventType, type AuthConfig, AuthContext, type AuthContextType, type AuthFormAutoSubmit, type AuthFormReturn, type AuthFormState, type AuthFormStateHandlers, type AuthFormSubmitHandlers, type AuthFormValidation, AuthProvider, type AuthProviderProps, type AuthStep, type DeleteAccountResult, type GuardInput, type OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, type SessionSnapshot, type SessionStatus, type TwoFactorDevice, type TwoFactorSetupData, type UseAuthFormOptions, type UseAuthFormStateReturn, type UseAutoAuthOptions, type UseDeleteAccountReturn, type UseGithubAuthOptions, type UseGithubAuthReturn, type UseTwoFactorOptions, type UseTwoFactorReturn, type UseTwoFactorSetupOptions, type UseTwoFactorSetupReturn, type UseTwoFactorStatusReturn, type UserProfile, type WebmailLink, authLogger, clearProfileCache, consumeSavedRedirect, decodeBase64, encodeBase64, formatAuthError, getCacheMetadata, getCachedProfile, hasValidCache, isAllowedAuthPath, logger, normalizePath, peekSavedRedirect, resolveGuardIsAuthenticated, resolveGuardIsLoading, setCachedProfile, shouldRedirectToAuth, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSession, useSessionStorage, useTwoFactor, useTwoFactorSetup, useTwoFactorStatus, validateEmail, validateIdentifier };