@djangocfg/api 2.1.55 → 2.1.57

package/src/generated/cfg_totp/_utils/hooks/totp__2fa_verification.ts

@@ -0,0 +1,62 @@
+// Auto-generated by DjangoCFG - see CLAUDE.md
+'use client';
+
+/**
+ * SWR Hooks for 2fa Verification
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+import { useSWRConfig } from 'swr'
+import * as Fetchers from '../fetchers/totp__2fa_verification'
+import type { API } from '../../index'
+import type { VerifyBackupRequest } from '../schemas/VerifyBackupRequest.schema'
+import type { VerifyRequest } from '../schemas/VerifyRequest.schema'
+import type { VerifyResponse } from '../schemas/VerifyResponse.schema'
+
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/totp/verify/
+ */
+export function useCreateTotpVerifyCreate() {
+  const { mutate } = useSWRConfig()
+
+  return async (data: VerifyRequest, client?: API): Promise<VerifyResponse> => {
+    const result = await Fetchers.createTotpVerifyCreate(data, client)
+    // Revalidate related queries
+    mutate('cfg-totp-verify')
+    return result
+  }
+}
+
+
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/totp/verify/backup/
+ */
+export function useCreateTotpVerifyBackupCreate() {
+  const { mutate } = useSWRConfig()
+
+  return async (data: VerifyBackupRequest, client?: API): Promise<VerifyResponse> => {
+    const result = await Fetchers.createTotpVerifyBackupCreate(data, client)
+    // Revalidate related queries
+    mutate('cfg-totp-verify-backup')
+    return result
+  }
+}
+
+

package/src/generated/cfg_totp/_utils/hooks/totp__backup_codes.ts

@@ -0,0 +1,59 @@
+// Auto-generated by DjangoCFG - see CLAUDE.md
+'use client';
+
+/**
+ * SWR Hooks for Backup Codes
+ *
+ * React hooks powered by SWR for data fetching with automatic caching,
+ * revalidation, and optimistic updates.
+ *
+ * Usage:
+ * ```typescript
+ * // Query hooks (GET)
+ * const { data, error, isLoading } = useUsers({ page: 1 })
+ *
+ * // Mutation hooks (POST/PUT/PATCH/DELETE)
+ * const createUser = useCreateUser()
+ * await createUser({ name: 'John', email: 'john@example.com' })
+ * ```
+ */
+import useSWR from 'swr'
+import { useSWRConfig } from 'swr'
+import * as Fetchers from '../fetchers/totp__backup_codes'
+import type { API } from '../../index'
+import type { BackupCodesRegenerateRequest } from '../schemas/BackupCodesRegenerateRequest.schema'
+import type { BackupCodesRegenerateResponse } from '../schemas/BackupCodesRegenerateResponse.schema'
+import type { BackupCodesStatus } from '../schemas/BackupCodesStatus.schema'
+
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/totp/backup-codes/
+ */
+export function useTotpBackupCodesRetrieve(client?: API): ReturnType<typeof useSWR<BackupCodesStatus>> {
+  return useSWR<BackupCodesStatus>(
+    'cfg-totp-backup-code',
+    () => Fetchers.getTotpBackupCodesRetrieve(client)
+  )
+}
+
+
+/**
+ * API operation
+ *
+ * @method POST
+ * @path /cfg/totp/backup-codes/regenerate/
+ */
+export function useCreateTotpBackupCodesRegenerateCreate() {
+  const { mutate } = useSWRConfig()
+
+  return async (data: BackupCodesRegenerateRequest, client?: API): Promise<BackupCodesRegenerateResponse> => {
+    const result = await Fetchers.createTotpBackupCodesRegenerateCreate(data, client)
+    // Revalidate related queries
+    mutate('cfg-totp-backup-codes-regenerate')
+    return result
+  }
+}
+
+

package/src/generated/cfg_totp/_utils/schemas/BackupCodesRegenerateRequest.schema.ts

@@ -0,0 +1,19 @@
+/**
+ * Zod schema for BackupCodesRegenerateRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for regenerating backup codes.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for regenerating backup codes.
+ */
+export const BackupCodesRegenerateRequestSchema = z.object({
+  code: z.string().min(6).max(6),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type BackupCodesRegenerateRequest = z.infer<typeof BackupCodesRegenerateRequestSchema>

package/src/generated/cfg_totp/_utils/schemas/BackupCodesRegenerateResponse.schema.ts

@@ -0,0 +1,20 @@
+/**
+ * Zod schema for BackupCodesRegenerateResponse
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Response serializer for backup codes regeneration.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Response serializer for backup codes regeneration.
+ */
+export const BackupCodesRegenerateResponseSchema = z.object({
+  backup_codes: z.array(z.string()),
+  warning: z.string(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type BackupCodesRegenerateResponse = z.infer<typeof BackupCodesRegenerateResponseSchema>

package/src/generated/cfg_totp/_utils/schemas/BackupCodesStatus.schema.ts

@@ -0,0 +1,21 @@
+/**
+ * Zod schema for BackupCodesStatus
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for backup codes status.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for backup codes status.
+ */
+export const BackupCodesStatusSchema = z.object({
+  remaining_count: z.int(),
+  total_generated: z.int(),
+  warning: z.string().nullable().optional(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type BackupCodesStatus = z.infer<typeof BackupCodesStatusSchema>

package/src/generated/cfg_totp/_utils/schemas/ConfirmSetupRequest.schema.ts

@@ -0,0 +1,20 @@
+/**
+ * Zod schema for ConfirmSetupRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for confirming 2FA setup with first code.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for confirming 2FA setup with first code.
+ */
+export const ConfirmSetupRequestSchema = z.object({
+  device_id: z.string().regex(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i),
+  code: z.string().min(6).max(6),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type ConfirmSetupRequest = z.infer<typeof ConfirmSetupRequestSchema>

package/src/generated/cfg_totp/_utils/schemas/ConfirmSetupResponse.schema.ts

@@ -0,0 +1,21 @@
+/**
+ * Zod schema for ConfirmSetupResponse
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Response serializer for setup confirmation.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Response serializer for setup confirmation.
+ */
+export const ConfirmSetupResponseSchema = z.object({
+  message: z.string(),
+  backup_codes: z.array(z.string()),
+  backup_codes_warning: z.string(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type ConfirmSetupResponse = z.infer<typeof ConfirmSetupResponseSchema>

package/src/generated/cfg_totp/_utils/schemas/DeviceList.schema.ts

@@ -0,0 +1,26 @@
+/**
+ * Zod schema for DeviceList
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for listing TOTP devices.
+ *  */
+import { z } from 'zod'
+import * as Enums from '../../enums'
+
+/**
+ * Serializer for listing TOTP devices.
+ */
+export const DeviceListSchema = z.object({
+  id: z.int(),
+  name: z.string(),
+  is_primary: z.boolean(),
+  status: z.nativeEnum(Enums.DeviceListStatus),
+  created_at: z.iso.datetime(),
+  confirmed_at: z.iso.datetime().nullable(),
+  last_used_at: z.iso.datetime().nullable(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type DeviceList = z.infer<typeof DeviceListSchema>

package/src/generated/cfg_totp/_utils/schemas/DisableRequest.schema.ts

@@ -0,0 +1,19 @@
+/**
+ * Zod schema for DisableRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for completely disabling 2FA.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for completely disabling 2FA.
+ */
+export const DisableRequestSchema = z.object({
+  code: z.string().min(6).max(6),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type DisableRequest = z.infer<typeof DisableRequestSchema>

package/src/generated/cfg_totp/_utils/schemas/PaginatedDeviceListList.schema.ts

@@ -0,0 +1,24 @@
+/**
+ * Zod schema for PaginatedDeviceListList
+ *
+ * This schema provides runtime validation and type inference.
+ *  */
+import { z } from 'zod'
+import { DeviceListSchema } from './DeviceList.schema'
+
+export const PaginatedDeviceListListSchema = z.object({
+  count: z.int(),
+  page: z.int(),
+  pages: z.int(),
+  page_size: z.int(),
+  has_next: z.boolean(),
+  has_previous: z.boolean(),
+  next_page: z.int().nullable().optional(),
+  previous_page: z.int().nullable().optional(),
+  results: z.array(DeviceListSchema),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type PaginatedDeviceListList = z.infer<typeof PaginatedDeviceListListSchema>

package/src/generated/cfg_totp/_utils/schemas/SetupRequest.schema.ts

@@ -0,0 +1,19 @@
+/**
+ * Zod schema for SetupRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for starting 2FA setup.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for starting 2FA setup.
+ */
+export const SetupRequestSchema = z.object({
+  device_name: z.string().min(1).max(100).optional(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type SetupRequest = z.infer<typeof SetupRequestSchema>

package/src/generated/cfg_totp/_utils/schemas/SetupResponse.schema.ts

@@ -0,0 +1,23 @@
+/**
+ * Zod schema for SetupResponse
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Response serializer for setup initiation.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Response serializer for setup initiation.
+ */
+export const SetupResponseSchema = z.object({
+  device_id: z.string().regex(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i),
+  secret: z.string(),
+  provisioning_uri: z.string(),
+  qr_code_base64: z.string(),
+  expires_in: z.int(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type SetupResponse = z.infer<typeof SetupResponseSchema>

package/src/generated/cfg_totp/_utils/schemas/VerifyBackupRequest.schema.ts

@@ -0,0 +1,20 @@
+/**
+ * Zod schema for VerifyBackupRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for backup code verification during login.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for backup code verification during login.
+ */
+export const VerifyBackupRequestSchema = z.object({
+  session_id: z.string().regex(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i),
+  backup_code: z.string().min(8).max(8),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type VerifyBackupRequest = z.infer<typeof VerifyBackupRequestSchema>

package/src/generated/cfg_totp/_utils/schemas/VerifyRequest.schema.ts

@@ -0,0 +1,20 @@
+/**
+ * Zod schema for VerifyRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Serializer for TOTP code verification during login.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Serializer for TOTP code verification during login.
+ */
+export const VerifyRequestSchema = z.object({
+  session_id: z.string().regex(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i),
+  code: z.string().min(6).max(6),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type VerifyRequest = z.infer<typeof VerifyRequestSchema>

package/src/generated/cfg_totp/_utils/schemas/VerifyResponse.schema.ts

@@ -0,0 +1,24 @@
+/**
+ * Zod schema for VerifyResponse
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Response serializer for successful 2FA verification.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Response serializer for successful 2FA verification.
+ */
+export const VerifyResponseSchema = z.object({
+  message: z.string(),
+  access_token: z.string(),
+  refresh_token: z.string(),
+  user: z.record(z.string(), z.any()),
+  remaining_backup_codes: z.int().optional(),
+  warning: z.string().optional(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type VerifyResponse = z.infer<typeof VerifyResponseSchema>

package/src/generated/cfg_totp/_utils/schemas/index.ts

@@ -0,0 +1,32 @@
+// Auto-generated by DjangoCFG - see CLAUDE.md
+/**
+ * Zod Schemas - Runtime validation and type inference
+ *
+ * Auto-generated from OpenAPI specification.
+ * Provides runtime validation for API requests and responses.
+ *
+ * Usage:
+ * ```typescript
+ * import { UserSchema } from './schemas'
+ *
+ * // Validate data
+ * const user = UserSchema.parse(data)
+ *
+ * // Type inference
+ * type User = z.infer<typeof UserSchema>
+ * ```
+ */
+
+export * from './BackupCodesRegenerateRequest.schema'
+export * from './BackupCodesRegenerateResponse.schema'
+export * from './BackupCodesStatus.schema'
+export * from './ConfirmSetupRequest.schema'
+export * from './ConfirmSetupResponse.schema'
+export * from './DeviceList.schema'
+export * from './DisableRequest.schema'
+export * from './PaginatedDeviceListList.schema'
+export * from './SetupRequest.schema'
+export * from './SetupResponse.schema'
+export * from './VerifyBackupRequest.schema'
+export * from './VerifyRequest.schema'
+export * from './VerifyResponse.schema'

package/src/generated/cfg_totp/api-instance.ts

@@ -0,0 +1,180 @@
+// Auto-generated by DjangoCFG - see CLAUDE.md
+/**
+ * Global API Instance - Singleton configuration with auto-configuration support
+ *
+ * This module provides a global API instance that auto-configures from
+ * environment variables or can be configured manually.
+ *
+ * AUTO-CONFIGURATION (recommended):
+ * Set one of these environment variables and the API will auto-configure:
+ * - NEXT_PUBLIC_API_URL (Next.js)
+ * - VITE_API_URL (Vite)
+ * - REACT_APP_API_URL (Create React App)
+ * - API_URL (generic)
+ *
+ * Then just use fetchers and hooks directly:
+ * ```typescript
+ * import { getUsers } from './_utils/fetchers'
+ * const users = await getUsers({ page: 1 })
+ * ```
+ *
+ * MANUAL CONFIGURATION:
+ * ```typescript
+ * import { configureAPI } from './api-instance'
+ *
+ * configureAPI({
+ *   baseUrl: 'https://api.example.com',
+ *   token: 'your-jwt-token'
+ * })
+ * ```
+ *
+ * For SSR or multiple instances:
+ * ```typescript
+ * import { API } from './index'
+ * import { getUsers } from './_utils/fetchers'
+ *
+ * const api = new API('https://api.example.com')
+ * const users = await getUsers({ page: 1 }, api)
+ * ```
+ */
+
+import { API, type APIOptions } from './index'
+
+let globalAPI: API | null = null
+let autoConfigAttempted = false
+
+/**
+ * Auto-configure from environment variable if available (Next.js pattern)
+ * This allows hooks and fetchers to work without explicit configureAPI() call
+ *
+ * Supported environment variables:
+ * - NEXT_PUBLIC_API_URL (Next.js)
+ * - VITE_API_URL (Vite)
+ * - REACT_APP_API_URL (Create React App)
+ * - API_URL (generic)
+ */
+function tryAutoConfigureFromEnv(): void {
+  // Only attempt once
+  if (autoConfigAttempted) return
+  autoConfigAttempted = true
+
+  // Skip if already configured
+  if (globalAPI) return
+
+  // Skip if process is not available (pure browser without bundler)
+  if (typeof process === 'undefined' || !process.env) return
+
+  // Try different environment variable patterns
+  const baseUrl =
+    process.env.NEXT_PUBLIC_API_URL ||
+    process.env.VITE_API_URL ||
+    process.env.REACT_APP_API_URL ||
+    process.env.API_URL
+
+  if (baseUrl) {
+    globalAPI = new API(baseUrl)
+  }
+}
+
+/**
+ * Get the global API instance
+ * Auto-configures from environment variables on first call if not manually configured.
+ * @throws Error if API is not configured and no env variable is set
+ */
+export function getAPIInstance(): API {
+  // Try auto-configuration on first access (lazy initialization)
+  tryAutoConfigureFromEnv()
+
+  if (!globalAPI) {
+    throw new Error(
+      'API not configured. Call configureAPI() with your base URL before using fetchers or hooks.\n\n' +
+      'Example:\n' +
+      '  import { configureAPI } from "./api-instance"\n' +
+      '  configureAPI({ baseUrl: "https://api.example.com" })\n\n' +
+      'Or set environment variable: NEXT_PUBLIC_API_URL, VITE_API_URL, or REACT_APP_API_URL'
+    )
+  }
+  return globalAPI
+}
+
+/**
+ * Check if API is configured (or can be auto-configured)
+ */
+export function isAPIConfigured(): boolean {
+  tryAutoConfigureFromEnv()
+  return globalAPI !== null
+}
+
+/**
+ * Configure the global API instance
+ *
+ * @param baseUrl - Base URL for the API
+ * @param options - Optional configuration (storage, retry, logger)
+ *
+ * @example
+ * ```typescript
+ * configureAPI({
+ *   baseUrl: 'https://api.example.com',
+ *   token: 'jwt-token',
+ *   options: {
+ *     retryConfig: { maxRetries: 3 },
+ *     loggerConfig: { enabled: true }
+ *   }
+ * })
+ * ```
+ */
+export function configureAPI(config: {
+  baseUrl: string
+  token?: string
+  refreshToken?: string
+  options?: APIOptions
+}): API {
+  globalAPI = new API(config.baseUrl, config.options)
+
+  if (config.token) {
+    globalAPI.setToken(config.token, config.refreshToken)
+  }
+
+  return globalAPI
+}
+
+/**
+ * Reconfigure the global API instance with new settings
+ * Useful for updating tokens or base URL
+ */
+export function reconfigureAPI(updates: {
+  baseUrl?: string
+  token?: string
+  refreshToken?: string
+}): API {
+  const instance = getAPIInstance()
+
+  if (updates.baseUrl) {
+    instance.setBaseUrl(updates.baseUrl)
+  }
+
+  if (updates.token) {
+    instance.setToken(updates.token, updates.refreshToken)
+  }
+
+  return instance
+}
+
+/**
+ * Clear tokens from the global API instance
+ */
+export function clearAPITokens(): void {
+  const instance = getAPIInstance()
+  instance.clearTokens()
+}
+
+/**
+ * Reset the global API instance
+ * Useful for testing or logout scenarios
+ */
+export function resetAPI(): void {
+  if (globalAPI) {
+    globalAPI.clearTokens()
+  }
+  globalAPI = null
+}