@djangocfg/api 2.1.448 → 2.1.450

package/dist/auth.d.cts

@@ -73,6 +73,10 @@ type OtpRequestResponse = {
      * Success message
      */
     message: string;
+    /**
+     * Webmail deep-link for the recipient's provider, or null if the domain is unknown.
+     */
+    webmail?: WebmailLink | null;
 };
 /**
  * Serializer for OTP verification.
@@ -190,6 +194,129 @@ type User = {
     readonly centrifugo: CentrifugoToken | null;
     readonly api_key: string | null;
 };
+/**
+ * Deep-link that opens the user's webmail on a search for our login email.
+ *
+ * Present only when the recipient's email domain maps to a known webmail
+ * provider (Gmail, Outlook, Mail.ru, Yandex, iCloud, …). For unknown/corporate
+ * domains this whole object is null and the frontend shows no button.
+ */
+type WebmailLink = {
+    /**
+     * Provider slug (e.g. 'gmail', 'outlook', 'mail_ru'). Also selects the brand icon on the frontend.
+     *
+     * * `gmail` - gmail
+     * * `outlook` - outlook
+     * * `yahoo` - yahoo
+     * * `icloud` - icloud
+     * * `proton` - proton
+     * * `zoho` - zoho
+     * * `aol` - aol
+     * * `fastmail` - fastmail
+     * * `gmx` - gmx
+     * * `mailcom` - mailcom
+     * * `mail_ru` - mail_ru
+     * * `yandex` - yandex
+     * * `rambler` - rambler
+     * * `qq` - qq
+     * * `netease` - netease
+     * * `sina` - sina
+     * * `aliyun` - aliyun
+     * * `naver` - naver
+     * * `daum` - daum
+     * * `web_de` - web_de
+     * * `tonline` - tonline
+     * * `seznam` - seznam
+     * * `wp_pl` - wp_pl
+     * * `o2_pl` - o2_pl
+     * * `interia` - interia
+     * * `libero` - libero
+     * * `virgilio` - virgilio
+     * * `orange` - orange
+     * * `laposte` - laposte
+     * * `free_fr` - free_fr
+     * * `sfr` - sfr
+     */
+    provider: WebmailLinkProviderEnum;
+    /**
+     * Human-facing provider name, e.g. 'Gmail'.
+     */
+    provider_name: string;
+    /**
+     * Absolute URL to open in a new tab (a sender-filtered search, or the inbox as fallback).
+     */
+    url: string;
+    /**
+     * True if the URL opens a search filtered to our sender; False if it only opens the inbox.
+     */
+    is_search: boolean;
+};
+/**
+ * * `gmail` - gmail
+ * * `outlook` - outlook
+ * * `yahoo` - yahoo
+ * * `icloud` - icloud
+ * * `proton` - proton
+ * * `zoho` - zoho
+ * * `aol` - aol
+ * * `fastmail` - fastmail
+ * * `gmx` - gmx
+ * * `mailcom` - mailcom
+ * * `mail_ru` - mail_ru
+ * * `yandex` - yandex
+ * * `rambler` - rambler
+ * * `qq` - qq
+ * * `netease` - netease
+ * * `sina` - sina
+ * * `aliyun` - aliyun
+ * * `naver` - naver
+ * * `daum` - daum
+ * * `web_de` - web_de
+ * * `tonline` - tonline
+ * * `seznam` - seznam
+ * * `wp_pl` - wp_pl
+ * * `o2_pl` - o2_pl
+ * * `interia` - interia
+ * * `libero` - libero
+ * * `virgilio` - virgilio
+ * * `orange` - orange
+ * * `laposte` - laposte
+ * * `free_fr` - free_fr
+ * * `sfr` - sfr
+ */
+declare enum WebmailLinkProviderEnum {
+    GMAIL = "gmail",
+    OUTLOOK = "outlook",
+    YAHOO = "yahoo",
+    ICLOUD = "icloud",
+    PROTON = "proton",
+    ZOHO = "zoho",
+    AOL = "aol",
+    FASTMAIL = "fastmail",
+    GMX = "gmx",
+    MAILCOM = "mailcom",
+    MAIL_RU = "mail_ru",
+    YANDEX = "yandex",
+    RAMBLER = "rambler",
+    QQ = "qq",
+    NETEASE = "netease",
+    SINA = "sina",
+    ALIYUN = "aliyun",
+    NAVER = "naver",
+    DAUM = "daum",
+    WEB_DE = "web_de",
+    TONLINE = "tonline",
+    SEZNAM = "seznam",
+    WP_PL = "wp_pl",
+    O2_PL = "o2_pl",
+    INTERIA = "interia",
+    LIBERO = "libero",
+    VIRGILIO = "virgilio",
+    ORANGE = "orange",
+    LAPOSTE = "laposte",
+    FREE_FR = "free_fr",
+    SFR = "sfr"
+}
 
 /**
  * Auth Form Types
@@ -204,6 +331,8 @@ interface OTPRequestResult {
     message: string;
     statusCode?: number;
     retryAfter?: number;
+    /** Webmail deep-link for the recipient's provider, or null if unknown. */
+    webmail?: WebmailLink | null;
 }
 interface AuthFormState {
     /** Email address */
@@ -232,6 +361,8 @@ interface AuthFormState {
     isRateLimited: boolean;
     /** Formatted countdown label, e.g. "19:00" or "42s" */
     rateLimitLabel: string;
+    /** Webmail deep-link for the current identifier's provider (null = no button). */
+    webmail: WebmailLink | null;
 }
 interface AuthFormStateHandlers {
     setIdentifier: (identifier: string) => void;
@@ -247,6 +378,8 @@ interface AuthFormStateHandlers {
     setUseBackupCode: (useBackup: boolean) => void;
     /** Start a countdown timer that disables submit for `seconds` seconds */
     startRateLimitCountdown: (seconds: number) => void;
+    /** Set (or clear) the webmail deep-link for the current identifier */
+    setWebmail: (webmail: WebmailLink | null) => void;
 }
 interface AuthFormSubmitHandlers {
     handleIdentifierSubmit: (e: React.FormEvent) => Promise<void>;
@@ -817,7 +950,9 @@ interface UseTokenRefreshOptions {
     onRefreshError?: (error: Error) => void;
 }
 /**
- * Hook for automatic token refresh
+ * Hook for proactive automatic token refresh.
+ * (JWT expiry helpers live in ../utils/jwt so they can be unit-tested and
+ * reused by the auth-bootstrap validation path.)
  */
 declare function useTokenRefresh(options?: UseTokenRefreshOptions): {
     refreshToken: () => Promise<boolean>;
@@ -918,4 +1053,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, type DeleteAccountResult, type OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, 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, authLogger, clearProfileCache, decodeBase64, encodeBase64, formatAuthError, getCacheMetadata, getCachedProfile, hasValidCache, logger, setCachedProfile, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthGuard, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSessionStorage, useTokenRefresh, 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 OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, 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, logger, setCachedProfile, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthGuard, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSessionStorage, useTokenRefresh, useTwoFactor, useTwoFactorSetup, useTwoFactorStatus, validateEmail, validateIdentifier };

package/dist/auth.d.ts

@@ -73,6 +73,10 @@ type OtpRequestResponse = {
      * Success message
      */
     message: string;
+    /**
+     * Webmail deep-link for the recipient's provider, or null if the domain is unknown.
+     */
+    webmail?: WebmailLink | null;
 };
 /**
  * Serializer for OTP verification.
@@ -190,6 +194,129 @@ type User = {
     readonly centrifugo: CentrifugoToken | null;
     readonly api_key: string | null;
 };
+/**
+ * Deep-link that opens the user's webmail on a search for our login email.
+ *
+ * Present only when the recipient's email domain maps to a known webmail
+ * provider (Gmail, Outlook, Mail.ru, Yandex, iCloud, …). For unknown/corporate
+ * domains this whole object is null and the frontend shows no button.
+ */
+type WebmailLink = {
+    /**
+     * Provider slug (e.g. 'gmail', 'outlook', 'mail_ru'). Also selects the brand icon on the frontend.
+     *
+     * * `gmail` - gmail
+     * * `outlook` - outlook
+     * * `yahoo` - yahoo
+     * * `icloud` - icloud
+     * * `proton` - proton
+     * * `zoho` - zoho
+     * * `aol` - aol
+     * * `fastmail` - fastmail
+     * * `gmx` - gmx
+     * * `mailcom` - mailcom
+     * * `mail_ru` - mail_ru
+     * * `yandex` - yandex
+     * * `rambler` - rambler
+     * * `qq` - qq
+     * * `netease` - netease
+     * * `sina` - sina
+     * * `aliyun` - aliyun
+     * * `naver` - naver
+     * * `daum` - daum
+     * * `web_de` - web_de
+     * * `tonline` - tonline
+     * * `seznam` - seznam
+     * * `wp_pl` - wp_pl
+     * * `o2_pl` - o2_pl
+     * * `interia` - interia
+     * * `libero` - libero
+     * * `virgilio` - virgilio
+     * * `orange` - orange
+     * * `laposte` - laposte
+     * * `free_fr` - free_fr
+     * * `sfr` - sfr
+     */
+    provider: WebmailLinkProviderEnum;
+    /**
+     * Human-facing provider name, e.g. 'Gmail'.
+     */
+    provider_name: string;
+    /**
+     * Absolute URL to open in a new tab (a sender-filtered search, or the inbox as fallback).
+     */
+    url: string;
+    /**
+     * True if the URL opens a search filtered to our sender; False if it only opens the inbox.
+     */
+    is_search: boolean;
+};
+/**
+ * * `gmail` - gmail
+ * * `outlook` - outlook
+ * * `yahoo` - yahoo
+ * * `icloud` - icloud
+ * * `proton` - proton
+ * * `zoho` - zoho
+ * * `aol` - aol
+ * * `fastmail` - fastmail
+ * * `gmx` - gmx
+ * * `mailcom` - mailcom
+ * * `mail_ru` - mail_ru
+ * * `yandex` - yandex
+ * * `rambler` - rambler
+ * * `qq` - qq
+ * * `netease` - netease
+ * * `sina` - sina
+ * * `aliyun` - aliyun
+ * * `naver` - naver
+ * * `daum` - daum
+ * * `web_de` - web_de
+ * * `tonline` - tonline
+ * * `seznam` - seznam
+ * * `wp_pl` - wp_pl
+ * * `o2_pl` - o2_pl
+ * * `interia` - interia
+ * * `libero` - libero
+ * * `virgilio` - virgilio
+ * * `orange` - orange
+ * * `laposte` - laposte
+ * * `free_fr` - free_fr
+ * * `sfr` - sfr
+ */
+declare enum WebmailLinkProviderEnum {
+    GMAIL = "gmail",
+    OUTLOOK = "outlook",
+    YAHOO = "yahoo",
+    ICLOUD = "icloud",
+    PROTON = "proton",
+    ZOHO = "zoho",
+    AOL = "aol",
+    FASTMAIL = "fastmail",
+    GMX = "gmx",
+    MAILCOM = "mailcom",
+    MAIL_RU = "mail_ru",
+    YANDEX = "yandex",
+    RAMBLER = "rambler",
+    QQ = "qq",
+    NETEASE = "netease",
+    SINA = "sina",
+    ALIYUN = "aliyun",
+    NAVER = "naver",
+    DAUM = "daum",
+    WEB_DE = "web_de",
+    TONLINE = "tonline",
+    SEZNAM = "seznam",
+    WP_PL = "wp_pl",
+    O2_PL = "o2_pl",
+    INTERIA = "interia",
+    LIBERO = "libero",
+    VIRGILIO = "virgilio",
+    ORANGE = "orange",
+    LAPOSTE = "laposte",
+    FREE_FR = "free_fr",
+    SFR = "sfr"
+}
 
 /**
  * Auth Form Types
@@ -204,6 +331,8 @@ interface OTPRequestResult {
     message: string;
     statusCode?: number;
     retryAfter?: number;
+    /** Webmail deep-link for the recipient's provider, or null if unknown. */
+    webmail?: WebmailLink | null;
 }
 interface AuthFormState {
     /** Email address */
@@ -232,6 +361,8 @@ interface AuthFormState {
     isRateLimited: boolean;
     /** Formatted countdown label, e.g. "19:00" or "42s" */
     rateLimitLabel: string;
+    /** Webmail deep-link for the current identifier's provider (null = no button). */
+    webmail: WebmailLink | null;
 }
 interface AuthFormStateHandlers {
     setIdentifier: (identifier: string) => void;
@@ -247,6 +378,8 @@ interface AuthFormStateHandlers {
     setUseBackupCode: (useBackup: boolean) => void;
     /** Start a countdown timer that disables submit for `seconds` seconds */
     startRateLimitCountdown: (seconds: number) => void;
+    /** Set (or clear) the webmail deep-link for the current identifier */
+    setWebmail: (webmail: WebmailLink | null) => void;
 }
 interface AuthFormSubmitHandlers {
     handleIdentifierSubmit: (e: React.FormEvent) => Promise<void>;
@@ -817,7 +950,9 @@ interface UseTokenRefreshOptions {
     onRefreshError?: (error: Error) => void;
 }
 /**
- * Hook for automatic token refresh
+ * Hook for proactive automatic token refresh.
+ * (JWT expiry helpers live in ../utils/jwt so they can be unit-tested and
+ * reused by the auth-bootstrap validation path.)
  */
 declare function useTokenRefresh(options?: UseTokenRefreshOptions): {
     refreshToken: () => Promise<boolean>;
@@ -918,4 +1053,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, type DeleteAccountResult, type OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, 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, authLogger, clearProfileCache, decodeBase64, encodeBase64, formatAuthError, getCacheMetadata, getCachedProfile, hasValidCache, logger, setCachedProfile, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthGuard, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSessionStorage, useTokenRefresh, 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 OTPRequestResult, type PatchedCfgUserUpdateRequest, PatchedCfgUserUpdateRequestSchema, type ProfileCacheOptions, 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, logger, setCachedProfile, useAccountsContext, useAuth, useAuthForm, useAuthFormState, useAuthGuard, useAuthRedirectManager, useAuthValidation, useAutoAuth, useBase64, useCfgRouter, useDeleteAccount, useGithubAuth, useLocalStorage, useQueryParams, useSessionStorage, useTokenRefresh, useTwoFactor, useTwoFactorSetup, useTwoFactorStatus, validateEmail, validateIdentifier };