@djangocfg/api 2.1.321 → 2.1.327

package/dist/auth.d.ts

@@ -1,232 +1,172 @@
 import React$1, { MutableRefObject, ReactNode } from 'react';
-import { z } from 'zod';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as consola from 'consola';
+import { z } from 'zod';
 
 /**
- * Zod schema for OTPRequestRequest
- *
- * This schema provides runtime validation and type inference.
- *  * Serializer for OTP request.
- *  */
-
-/**
- * Serializer for OTP request.
+ * Nested serializer for Centrifugo WebSocket connection token.
  */
-declare const OTPRequestRequestSchema: z.ZodObject<{
-    identifier: z.ZodString;
-    source_url: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
+type CentrifugoToken = {
+    /**
+     * JWT token for Centrifugo WebSocket connection
+     */
+    token: string;
+    /**
+     * Centrifugo WebSocket URL
+     */
+    centrifugo_url: string;
+    /**
+     * Token expiration time (ISO 8601)
+     */
+    expires_at: string;
+    /**
+     * List of allowed channels for this user
+     */
+    channels: Array<string>;
+};
 /**
- * Infer TypeScript type from Zod schema
+ * Serializer for updating user profile.
  */
-type OTPRequestRequest = z.infer<typeof OTPRequestRequestSchema>;
-
-/**
- * Zod schema for OTPRequestResponse
- *
- * This schema provides runtime validation and type inference.
- *  * OTP request response.
- *  */
-
+type CfgUserUpdateRequest = {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+};
 /**
- * OTP request response.
+ * Serializer for OTP request.
  */
-declare const OTPRequestResponseSchema: z.ZodObject<{
-    message: z.ZodString;
-}, z.core.$strip>;
+type OtpRequestRequest = {
+    /**
+     * Email address for OTP delivery
+     */
+    identifier: string;
+    /**
+     * Source URL for tracking registration (e.g., https://my.djangocfg.com)
+     */
+    source_url?: string;
+};
 /**
- * Infer TypeScript type from Zod schema
+ * OTP request response.
  */
-type OTPRequestResponse = z.infer<typeof OTPRequestResponseSchema>;
-
-/**
- * Zod schema for OTPVerifyRequest
- *
- * This schema provides runtime validation and type inference.
- *  * Serializer for OTP verification.
- *  */
-
+type OtpRequestResponse = {
+    /**
+     * Success message
+     */
+    message: string;
+};
 /**
  * Serializer for OTP verification.
  */
-declare const OTPVerifyRequestSchema: z.ZodObject<{
-    identifier: z.ZodString;
-    otp: z.ZodString;
-    source_url: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-/**
- * Infer TypeScript type from Zod schema
- */
-type OTPVerifyRequest = z.infer<typeof OTPVerifyRequestSchema>;
-
-/**
- * Zod schema for OTPVerifyResponse
- *
- * This schema provides runtime validation and type inference.
- *  * OTP verification response.
-
-When 2FA is required:
-- requires_2fa: True
-- session_id: UUID of 2FA verification session
-- refresh/access/user: null
-
-When 2FA is not required:
-- requires_2fa: False
-- session_id: null
-- refresh/access/user: populated
- *  */
-
+type OtpVerifyRequest = {
+    /**
+     * Email address used for OTP request
+     */
+    identifier: string;
+    otp: string;
+    /**
+     * Source URL for tracking login (e.g., https://my.djangocfg.com)
+     */
+    source_url?: string;
+};
 /**
  * OTP verification response.
-
-When 2FA is required:
-- requires_2fa: True
-- session_id: UUID of 2FA verification session
-- refresh/access/user: null
-
-When 2FA is not required:
-- requires_2fa: False
-- session_id: null
-- refresh/access/user: populated
- */
-declare const OTPVerifyResponseSchema: z.ZodObject<{
-    requires_2fa: z.ZodOptional<z.ZodBoolean>;
-    session_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    refresh: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    access: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    user: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        id: z.ZodNumber;
-        email: z.ZodEmail;
-        first_name: z.ZodOptional<z.ZodString>;
-        last_name: z.ZodOptional<z.ZodString>;
-        full_name: z.ZodString;
-        initials: z.ZodString;
-        display_username: z.ZodString;
-        company: z.ZodOptional<z.ZodString>;
-        phone: z.ZodOptional<z.ZodString>;
-        position: z.ZodOptional<z.ZodString>;
-        language: z.ZodOptional<z.ZodString>;
-        avatar: z.ZodNullable<z.ZodString>;
-        is_staff: z.ZodBoolean;
-        is_superuser: z.ZodBoolean;
-        date_joined: z.ZodString;
-        last_login: z.ZodNullable<z.ZodString>;
-        unanswered_messages_count: z.ZodNumber;
-        centrifugo: z.ZodNullable<z.ZodObject<{
-            token: z.ZodString;
-            centrifugo_url: z.ZodString;
-            expires_at: z.ZodString;
-            channels: z.ZodArray<z.ZodString>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>>;
-    should_prompt_2fa: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-/**
- * Infer TypeScript type from Zod schema
- */
-type OTPVerifyResponse = z.infer<typeof OTPVerifyResponseSchema>;
-
-/**
- * Zod schema for PatchedUserProfileUpdateRequest
  *
- * This schema provides runtime validation and type inference.
- *  * Serializer for updating user profile.
- *  */
-
-/**
- * Serializer for updating user profile.
- */
-declare const PatchedUserProfileUpdateRequestSchema: z.ZodObject<{
-    first_name: z.ZodOptional<z.ZodString>;
-    last_name: z.ZodOptional<z.ZodString>;
-    company: z.ZodOptional<z.ZodString>;
-    phone: z.ZodOptional<z.ZodString>;
-    position: z.ZodOptional<z.ZodString>;
-    language: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-/**
- * Infer TypeScript type from Zod schema
- */
-type PatchedUserProfileUpdateRequest = z.infer<typeof PatchedUserProfileUpdateRequestSchema>;
-
-/**
- * Zod schema for TokenRefresh
- *
- * This schema provides runtime validation and type inference.
- *  */
-
-declare const TokenRefreshSchema: z.ZodObject<{
-    access: z.ZodString;
-    refresh: z.ZodString;
-}, z.core.$strip>;
-/**
- * Infer TypeScript type from Zod schema
- */
-type TokenRefresh = z.infer<typeof TokenRefreshSchema>;
-
-/**
- * Zod schema for User
+ * When 2FA is required:
+ * - requires_2fa: True
+ * - session_id: UUID of 2FA verification session
+ * - refresh/access/user: null
  *
- * This schema provides runtime validation and type inference.
- *  * Serializer for user details.
- *  */
-
-/**
- * Serializer for user details.
- */
-declare const UserSchema: z.ZodObject<{
-    id: z.ZodNumber;
-    email: z.ZodEmail;
-    first_name: z.ZodOptional<z.ZodString>;
-    last_name: z.ZodOptional<z.ZodString>;
-    full_name: z.ZodString;
-    initials: z.ZodString;
-    display_username: z.ZodString;
-    company: z.ZodOptional<z.ZodString>;
-    phone: z.ZodOptional<z.ZodString>;
-    position: z.ZodOptional<z.ZodString>;
-    language: z.ZodOptional<z.ZodString>;
-    avatar: z.ZodNullable<z.ZodString>;
-    is_staff: z.ZodBoolean;
-    is_superuser: z.ZodBoolean;
-    date_joined: z.ZodString;
-    last_login: z.ZodNullable<z.ZodString>;
-    unanswered_messages_count: z.ZodNumber;
-    centrifugo: z.ZodNullable<z.ZodObject<{
-        token: z.ZodString;
-        centrifugo_url: z.ZodString;
-        expires_at: z.ZodString;
-        channels: z.ZodArray<z.ZodString>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-/**
- * Infer TypeScript type from Zod schema
+ * When 2FA is not required:
+ * - requires_2fa: False
+ * - session_id: null
+ * - refresh/access/user: populated
  */
-type User = z.infer<typeof UserSchema>;
-
-/**
- * Zod schema for UserProfileUpdateRequest
- *
- * This schema provides runtime validation and type inference.
- *  * Serializer for updating user profile.
- *  */
-
+type OtpVerifyResponse = {
+    /**
+     * Whether 2FA verification is required
+     */
+    requires_2fa?: boolean;
+    /**
+     * 2FA session ID (if requires_2fa is True)
+     */
+    session_id?: string | null;
+    /**
+     * JWT refresh token (if requires_2fa is False)
+     */
+    refresh?: string | null;
+    /**
+     * JWT access token (if requires_2fa is False)
+     */
+    access?: string | null;
+    /**
+     * User information (if requires_2fa is False)
+     */
+    user?: User | null;
+    /**
+     * Whether user should be prompted to enable 2FA
+     */
+    should_prompt_2fa?: boolean;
+};
 /**
  * Serializer for updating user profile.
  */
-declare const UserProfileUpdateRequestSchema: z.ZodObject<{
-    first_name: z.ZodOptional<z.ZodString>;
-    last_name: z.ZodOptional<z.ZodString>;
-    company: z.ZodOptional<z.ZodString>;
-    phone: z.ZodOptional<z.ZodString>;
-    position: z.ZodOptional<z.ZodString>;
-    language: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
+type PatchedCfgUserUpdateRequest = {
+    first_name?: string;
+    last_name?: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+};
+type TokenRefresh = {
+    readonly access: string;
+    refresh: string;
+};
 /**
- * Infer TypeScript type from Zod schema
+ * Serializer for user details.
  */
-type UserProfileUpdateRequest = z.infer<typeof UserProfileUpdateRequestSchema>;
+type User = {
+    readonly id: number;
+    readonly email: string;
+    first_name?: string;
+    last_name?: string;
+    /**
+     * Get user's full name.
+     */
+    readonly full_name: string;
+    /**
+     * Get user's initials for avatar fallback.
+     */
+    readonly initials: string;
+    /**
+     * Get formatted username for display.
+     */
+    readonly display_username: string;
+    company?: string;
+    phone?: string;
+    position?: string;
+    language?: string;
+    readonly avatar: string | null;
+    /**
+     * Staff status
+     *
+     * Designates whether the user can log into this admin site.
+     */
+    readonly is_staff: boolean;
+    /**
+     * Superuser status
+     *
+     * Designates that this user has all permissions without explicitly assigning them.
+     */
+    readonly is_superuser: boolean;
+    readonly date_joined: string;
+    readonly last_login: string | null;
+    readonly unanswered_messages_count: number;
+    readonly centrifugo: CentrifugoToken | null;
+};
 
 /**
  * Auth Form Types
@@ -401,19 +341,28 @@ declare const AuthProvider: React$1.FC<AuthProviderProps>;
  */
 declare const useAuth: () => AuthContextType;
 
+declare const PatchedCfgUserUpdateRequestSchema: z.ZodObject<{
+    first_name: z.ZodOptional<z.ZodString>;
+    last_name: z.ZodOptional<z.ZodString>;
+    company: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    position: z.ZodOptional<z.ZodString>;
+    language: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+
 interface AccountsContextValue {
     profile?: User;
     isLoadingProfile: boolean;
     profileError: Error | null;
-    updateProfile: (data: UserProfileUpdateRequest) => Promise<User>;
-    partialUpdateProfile: (data: PatchedUserProfileUpdateRequest) => Promise<User>;
+    updateProfile: (data: CfgUserUpdateRequest) => Promise<User>;
+    partialUpdateProfile: (data: PatchedCfgUserUpdateRequest) => Promise<User>;
     uploadAvatar: (avatar: File | Blob) => Promise<User>;
     refreshProfile: (options?: {
         callerId?: string;
         force?: boolean;
     }) => Promise<User | undefined>;
-    requestOTP: (data: OTPRequestRequest) => Promise<OTPRequestResponse>;
-    verifyOTP: (data: OTPVerifyRequest) => Promise<OTPVerifyResponse>;
+    requestOTP: (data: OtpRequestRequest) => Promise<OtpRequestResponse>;
+    verifyOTP: (data: OtpVerifyRequest) => Promise<OtpVerifyResponse>;
     refreshToken: (refresh: string) => Promise<TokenRefresh>;
     logout: () => void;
 }
@@ -941,4 +890,4 @@ declare const Analytics: {
     setUser(userId: string): void;
 };
 
-export { type AccountsContextValue, AccountsProvider, Analytics, AnalyticsCategory, type AnalyticsCategoryType, AnalyticsEvent, type AnalyticsEventType, type AuthConfig, type AuthContextType, type AuthFormAutoSubmit, type AuthFormReturn, type AuthFormState, type AuthFormStateHandlers, type AuthFormSubmitHandlers, type AuthFormValidation, AuthProvider, type AuthProviderProps, type AuthStep, type DeleteAccountResult, type OTPRequestResult, type PatchedUserProfileUpdateRequest, PatchedUserProfileUpdateRequestSchema, 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 { type AccountsContextValue, AccountsProvider, Analytics, AnalyticsCategory, type AnalyticsCategoryType, AnalyticsEvent, type AnalyticsEventType, type AuthConfig, 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 };