@djangocfg/api 1.2.4 → 1.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djangocfg/api",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "author": {
     "name": "DjangoCFG",
     "url": "https://djangocfg.com"
@@ -68,7 +68,7 @@
     "@types/node": "^22.15.3",
     "@types/react": "19.2.2",
     "@types/react-dom": "19.2.1",
-    "@djangocfg/typescript-config": "^1.2.4",
+    "@djangocfg/typescript-config": "^1.2.6",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "tsup": "^8.5.0",

package/src/cfg/contexts/TasksContext.tsx

@@ -0,0 +1,242 @@
+"use client";
+
+import { createContext, useContext, ReactNode } from 'react';
+import { useSWRConfig } from 'swr';
+import { api } from '../BaseClient';
+import {
+  useTasksApiTasksStatsRetrieve,
+  useTasksApiQueuesStatusRetrieve,
+  useTasksApiWorkersListRetrieve,
+  useCreateTasksApiClearCreate,
+  useCreateTasksApiClearQueuesCreate,
+  useCreateTasksApiPurgeFailedCreate,
+  useCreateTasksApiQueuesManageCreate,
+  useCreateTasksApiWorkersManageCreate,
+} from '../generated/_utils/hooks/cfg__tasks';
+import type { API } from '../generated';
+import type {
+  TaskStatistics,
+  QueueStatus,
+  APIResponseRequest,
+  APIResponse,
+  QueueActionRequest,
+  QueueAction,
+  WorkerActionRequest,
+  WorkerAction,
+} from '../generated/_utils/schemas';
+
+// ─────────────────────────────────────────────────────────────────────────
+// Context Type
+// ─────────────────────────────────────────────────────────────────────────
+
+interface TasksContextValue {
+  // Statistics
+  stats: TaskStatistics | undefined;
+  isLoadingStats: boolean;
+  statsError: Error | null;
+
+  // Queues
+  queues: QueueStatus | undefined;
+  isLoadingQueues: boolean;
+  queuesError: Error | null;
+
+  // Workers
+  workers: APIResponse | undefined;
+  isLoadingWorkers: boolean;
+  workersError: Error | null;
+
+  // Management operations
+  clearTasks: (data: APIResponseRequest) => Promise<APIResponse>;
+  clearQueues: (data: APIResponseRequest) => Promise<APIResponse>;
+  purgeFailedTasks: (data: APIResponseRequest) => Promise<APIResponse>;
+  queueAction: (data: QueueActionRequest) => Promise<QueueAction>;
+  workerAction: (data: WorkerActionRequest) => Promise<WorkerAction>;
+
+  // Refresh functions
+  refreshStats: () => void;
+  refreshQueues: () => void;
+  refreshWorkers: () => void;
+  refreshAll: () => void;
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Context
+// ─────────────────────────────────────────────────────────────────────────
+
+const TasksContext = createContext<TasksContextValue | undefined>(undefined);
+
+// ─────────────────────────────────────────────────────────────────────────
+// Provider Props
+// ─────────────────────────────────────────────────────────────────────────
+
+interface TasksProviderProps {
+  children: ReactNode;
+  autoRefresh?: boolean;
+  refreshInterval?: number; // in milliseconds
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Provider Component
+// ─────────────────────────────────────────────────────────────────────────
+
+export function TasksProvider({
+  children,
+  autoRefresh = false,
+  refreshInterval = 5000,
+}: TasksProviderProps) {
+  const { mutate } = useSWRConfig();
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Fetch Statistics
+  // ───────────────────────────────────────────────────────────────────────
+
+  const {
+    data: stats,
+    error: statsError,
+    isLoading: isLoadingStats,
+    mutate: mutateStats,
+  } = useTasksApiTasksStatsRetrieve(api as unknown as API);
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Fetch Queues
+  // ───────────────────────────────────────────────────────────────────────
+
+  const {
+    data: queues,
+    error: queuesError,
+    isLoading: isLoadingQueues,
+    mutate: mutateQueues,
+  } = useTasksApiQueuesStatusRetrieve(api as unknown as API);
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Fetch Workers
+  // ───────────────────────────────────────────────────────────────────────
+
+  const {
+    data: workers,
+    error: workersError,
+    isLoading: isLoadingWorkers,
+    mutate: mutateWorkers,
+  } = useTasksApiWorkersListRetrieve(api as unknown as API);
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Mutation Hooks
+  // ───────────────────────────────────────────────────────────────────────
+
+  const clearTasksMutation = useCreateTasksApiClearCreate();
+  const clearQueuesMutation = useCreateTasksApiClearQueuesCreate();
+  const purgeFailedMutation = useCreateTasksApiPurgeFailedCreate();
+  const queueActionMutation = useCreateTasksApiQueuesManageCreate();
+  const workerActionMutation = useCreateTasksApiWorkersManageCreate();
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Operations
+  // ───────────────────────────────────────────────────────────────────────
+
+  const clearTasks = async (data: APIResponseRequest): Promise<APIResponse> => {
+    const result = await clearTasksMutation(data, api as unknown as API);
+    // Refresh all data after clearing
+    await mutateStats();
+    await mutateQueues();
+    return result as APIResponse;
+  };
+
+  const clearQueues = async (data: APIResponseRequest): Promise<APIResponse> => {
+    const result = await clearQueuesMutation(data, api as unknown as API);
+    await mutateQueues();
+    await mutateStats();
+    return result as APIResponse;
+  };
+
+  const purgeFailedTasks = async (data: APIResponseRequest): Promise<APIResponse> => {
+    const result = await purgeFailedMutation(data, api as unknown as API);
+    await mutateStats();
+    await mutateQueues();
+    return result as APIResponse;
+  };
+
+  const queueAction = async (data: QueueActionRequest): Promise<QueueAction> => {
+    const result = await queueActionMutation(data, api as unknown as API);
+    await mutateQueues();
+    await mutateStats();
+    return result as QueueAction;
+  };
+
+  const workerAction = async (data: WorkerActionRequest): Promise<WorkerAction> => {
+    const result = await workerActionMutation(data, api as unknown as API);
+    await mutateWorkers();
+    await mutateStats();
+    return result as WorkerAction;
+  };
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Refresh Functions
+  // ───────────────────────────────────────────────────────────────────────
+
+  const refreshStats = () => mutateStats();
+  const refreshQueues = () => mutateQueues();
+  const refreshWorkers = () => mutateWorkers();
+  const refreshAll = () => {
+    mutateStats();
+    mutateQueues();
+    mutateWorkers();
+  };
+
+  // ───────────────────────────────────────────────────────────────────────
+  // Context Value
+  // ───────────────────────────────────────────────────────────────────────
+
+  const value: TasksContextValue = {
+    // Statistics
+    stats,
+    isLoadingStats,
+    statsError,
+
+    // Queues
+    queues,
+    isLoadingQueues,
+    queuesError,
+
+    // Workers
+    workers,
+    isLoadingWorkers,
+    workersError,
+
+    // Operations
+    clearTasks,
+    clearQueues,
+    purgeFailedTasks,
+    queueAction,
+    workerAction,
+
+    // Refresh
+    refreshStats,
+    refreshQueues,
+    refreshWorkers,
+    refreshAll,
+  };
+
+  return (
+    <TasksContext.Provider value={value}>
+      {children}
+    </TasksContext.Provider>
+  );
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Hook
+// ─────────────────────────────────────────────────────────────────────────
+
+export function useTasks() {
+  const context = useContext(TasksContext);
+  if (context === undefined) {
+    throw new Error('useTasks must be used within a TasksProvider');
+  }
+  return context;
+}
+
+// ─────────────────────────────────────────────────────────────────────────
+// Exports
+// ─────────────────────────────────────────────────────────────────────────
+
+export type { TasksContextValue, TasksProviderProps };

package/src/cfg/contexts/index.ts

@@ -46,3 +46,6 @@ export * from './payments';
 // Knowbase (Chat, Documents, Sessions)
 export * from './knowbase';
 
+// Tasks (Dramatiq Task Management)
+export { TasksProvider, useTasks } from './TasksContext';
+export type { TasksContextValue, TasksProviderProps } from './TasksContext';

package/src/cfg/generated/_utils/fetchers/cfg__accounts.ts

@@ -42,7 +42,7 @@ import type { API } from '../../index'
  * @method POST
  * @path /cfg/accounts/otp/request/
  */
-export async function createAccountsOtpRequestCreate(  data: OTPRequestRequest,  client?
+export async function createAccountsOtpRequestCreate(  data: OTPRequestRequest,  client?: API
 ): Promise<OTPRequestResponse> {
   const api = client || getAPIInstance()
   const response = await api.cfg_accounts.otpRequestCreate(data)
@@ -56,7 +56,7 @@ export async function createAccountsOtpRequestCreate(  data: OTPRequestRequest,
  * @method POST
  * @path /cfg/accounts/otp/verify/
  */
-export async function createAccountsOtpVerifyCreate(  data: OTPVerifyRequest,  client?
+export async function createAccountsOtpVerifyCreate(  data: OTPVerifyRequest,  client?: API
 ): Promise<OTPVerifyResponse> {
   const api = client || getAPIInstance()
   const response = await api.cfg_accounts.otpVerifyCreate(data)

package/src/cfg/generated/_utils/fetchers/cfg__accounts__auth.ts

@@ -40,7 +40,7 @@ import type { API } from '../../index'
  * @method POST
  * @path /cfg/accounts/token/refresh/
  */
-export async function createAccountsTokenRefreshCreate(  data: TokenRefreshRequest,  client?
+export async function createAccountsTokenRefreshCreate(  data: TokenRefreshRequest,  client?: API
 ): Promise<TokenRefresh> {
   const api = client || getAPIInstance()
   const response = await api.cfg_auth.accountsTokenRefreshCreate(data)

package/src/cfg/generated/_utils/fetchers/cfg__accounts__user_profile.ts

@@ -41,7 +41,7 @@ import type { API } from '../../index'
  * @method GET
  * @path /cfg/accounts/profile/
  */
-export async function getAccountsProfileRetrieve(  client?
+export async function getAccountsProfileRetrieve(  client?: API
 ): Promise<User> {
   const api = client || getAPIInstance()
   const response = await api.cfg_user_profile.accountsProfileRetrieve()
@@ -55,7 +55,7 @@ export async function getAccountsProfileRetrieve(  client?
  * @method POST
  * @path /cfg/accounts/profile/avatar/
  */
-export async function createAccountsProfileAvatarCreate(  data: any,  client?
+export async function createAccountsProfileAvatarCreate(  data: any,  client?: API
 ): Promise<User> {
   const api = client || getAPIInstance()
   const response = await api.cfg_user_profile.accountsProfileAvatarCreate(data)
@@ -69,7 +69,7 @@ export async function createAccountsProfileAvatarCreate(  data: any,  client?
  * @method PUT
  * @path /cfg/accounts/profile/partial/
  */
-export async function partialUpdateAccountsProfilePartialUpdate(  data: UserProfileUpdateRequest,  client?
+export async function partialUpdateAccountsProfilePartialUpdate(  data: UserProfileUpdateRequest,  client?: API
 ): Promise<User> {
   const api = client || getAPIInstance()
   const response = await api.cfg_user_profile.accountsProfilePartialUpdate(data)
@@ -83,7 +83,7 @@ export async function partialUpdateAccountsProfilePartialUpdate(  data: UserProf
  * @method PATCH
  * @path /cfg/accounts/profile/partial/
  */
-export async function partialUpdateAccountsProfilePartialPartialUpdate(  data?: PatchedUserProfileUpdateRequest,  client?
+export async function partialUpdateAccountsProfilePartialPartialUpdate(  data?: PatchedUserProfileUpdateRequest,  client?: API
 ): Promise<User> {
   const api = client || getAPIInstance()
   const response = await api.cfg_user_profile.accountsProfilePartialPartialUpdate(data)
@@ -97,7 +97,7 @@ export async function partialUpdateAccountsProfilePartialPartialUpdate(  data?:
  * @method PUT
  * @path /cfg/accounts/profile/update/
  */
-export async function updateAccountsProfileUpdateUpdate(  data: UserProfileUpdateRequest,  client?
+export async function updateAccountsProfileUpdateUpdate(  data: UserProfileUpdateRequest,  client?: API
 ): Promise<User> {
   const api = client || getAPIInstance()
   const response = await api.cfg_user_profile.accountsProfileUpdateUpdate(data)
@@ -111,7 +111,7 @@ export async function updateAccountsProfileUpdateUpdate(  data: UserProfileUpdat
  * @method PATCH
  * @path /cfg/accounts/profile/update/
  */
-export async function partialUpdateAccountsProfileUpdatePartialUpdate(  data?: PatchedUserProfileUpdateRequest,  client?
+export async function partialUpdateAccountsProfileUpdatePartialUpdate(  data?: PatchedUserProfileUpdateRequest,  client?: API
 ): Promise<User> {
   const api = client || getAPIInstance()
   const response = await api.cfg_user_profile.accountsProfileUpdatePartialUpdate(data)

package/src/cfg/generated/_utils/fetchers/cfg__centrifugo.ts

@@ -0,0 +1,62 @@
+/**
+ * Typed fetchers for Centrifugo
+ *
+ * Universal functions that work in any environment:
+ * - Next.js (App Router / Pages Router / Server Components)
+ * - React Native
+ * - Node.js backend
+ *
+ * These fetchers use Zod schemas for runtime validation.
+ *
+ * Usage:
+ * ```typescript
+ * // Configure API once (in your app entry point)
+ * import { configureAPI } from '../../api-instance'
+ * configureAPI({ baseUrl: 'https://api.example.com' })
+ *
+ * // Then use fetchers anywhere
+ * const users = await getUsers({ page: 1 })
+ *
+ * // With SWR
+ * const { data } = useSWR(['users', params], () => getUsers(params))
+ *
+ * // With React Query
+ * const { data } = useQuery(['users', params], () => getUsers(params))
+ *
+ * // In Server Component or SSR (pass custom client)
+ * import { API } from '../../index'
+ * const api = new API('https://api.example.com')
+ * const users = await getUsers({ page: 1 }, api)
+ * ```
+ */
+import { getAPIInstance } from '../../api-instance'
+import type { API } from '../../index'
+
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/centrifugo/admin/api/monitor/channels/
+ */
+export async function getCentrifugoAdminApiMonitorChannelsRetrieve(  client?: API
+): Promise<any> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo.adminApiMonitorChannelsRetrieve()
+  return response
+}
+
+
+/**
+ * API operation
+ *
+ * @method GET
+ * @path /cfg/centrifugo/monitor/channels/
+ */
+export async function getCentrifugoMonitorChannelsRetrieve(  client?: API
+): Promise<any> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo.monitorChannelsRetrieve()
+  return response
+}
+
+

package/src/cfg/generated/_utils/fetchers/cfg__centrifugo__centrifugo_admin_api.ts

@@ -0,0 +1,211 @@
+/**
+ * Typed fetchers for Centrifugo Admin API
+ *
+ * Universal functions that work in any environment:
+ * - Next.js (App Router / Pages Router / Server Components)
+ * - React Native
+ * - Node.js backend
+ *
+ * These fetchers use Zod schemas for runtime validation.
+ *
+ * Usage:
+ * ```typescript
+ * // Configure API once (in your app entry point)
+ * import { configureAPI } from '../../api-instance'
+ * configureAPI({ baseUrl: 'https://api.example.com' })
+ *
+ * // Then use fetchers anywhere
+ * const users = await getUsers({ page: 1 })
+ *
+ * // With SWR
+ * const { data } = useSWR(['users', params], () => getUsers(params))
+ *
+ * // With React Query
+ * const { data } = useQuery(['users', params], () => getUsers(params))
+ *
+ * // In Server Component or SSR (pass custom client)
+ * import { API } from '../../index'
+ * const api = new API('https://api.example.com')
+ * const users = await getUsers({ page: 1 }, api)
+ * ```
+ */
+import { CentrifugoChannelsRequestRequestSchema, type CentrifugoChannelsRequestRequest } from '../schemas/CentrifugoChannelsRequestRequest.schema'
+import { CentrifugoChannelsResponseSchema, type CentrifugoChannelsResponse } from '../schemas/CentrifugoChannelsResponse.schema'
+import { CentrifugoHistoryRequestRequestSchema, type CentrifugoHistoryRequestRequest } from '../schemas/CentrifugoHistoryRequestRequest.schema'
+import { CentrifugoHistoryResponseSchema, type CentrifugoHistoryResponse } from '../schemas/CentrifugoHistoryResponse.schema'
+import { CentrifugoInfoResponseSchema, type CentrifugoInfoResponse } from '../schemas/CentrifugoInfoResponse.schema'
+import { CentrifugoPresenceRequestRequestSchema, type CentrifugoPresenceRequestRequest } from '../schemas/CentrifugoPresenceRequestRequest.schema'
+import { CentrifugoPresenceResponseSchema, type CentrifugoPresenceResponse } from '../schemas/CentrifugoPresenceResponse.schema'
+import { CentrifugoPresenceStatsRequestRequestSchema, type CentrifugoPresenceStatsRequestRequest } from '../schemas/CentrifugoPresenceStatsRequestRequest.schema'
+import { CentrifugoPresenceStatsResponseSchema, type CentrifugoPresenceStatsResponse } from '../schemas/CentrifugoPresenceStatsResponse.schema'
+import { getAPIInstance } from '../../api-instance'
+import type { API } from '../../index'
+
+/**
+ * Get connection token for dashboard
+ *
+ * @method POST
+ * @path /cfg/centrifugo/admin/api/server/auth/token/
+ */
+export async function createCentrifugoAdminApiServerAuthTokenCreate(  client?: API
+): Promise<any> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.serverAuthTokenCreate()
+  return response
+}
+
+
+/**
+ * List active channels
+ *
+ * @method POST
+ * @path /cfg/centrifugo/admin/api/server/channels/
+ */
+export async function createCentrifugoAdminApiServerChannelsCreate(  data: CentrifugoChannelsRequestRequest,  client?: API
+): Promise<CentrifugoChannelsResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.serverChannelsCreate(data)
+  return CentrifugoChannelsResponseSchema.parse(response)
+}
+
+
+/**
+ * Get channel history
+ *
+ * @method POST
+ * @path /cfg/centrifugo/admin/api/server/history/
+ */
+export async function createCentrifugoAdminApiServerHistoryCreate(  data: CentrifugoHistoryRequestRequest,  client?: API
+): Promise<CentrifugoHistoryResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.serverHistoryCreate(data)
+  return CentrifugoHistoryResponseSchema.parse(response)
+}
+
+
+/**
+ * Get Centrifugo server info
+ *
+ * @method POST
+ * @path /cfg/centrifugo/admin/api/server/info/
+ */
+export async function createCentrifugoAdminApiServerInfoCreate(  client?: API
+): Promise<CentrifugoInfoResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.serverInfoCreate()
+  return CentrifugoInfoResponseSchema.parse(response)
+}
+
+
+/**
+ * Get channel presence
+ *
+ * @method POST
+ * @path /cfg/centrifugo/admin/api/server/presence/
+ */
+export async function createCentrifugoAdminApiServerPresenceCreate(  data: CentrifugoPresenceRequestRequest,  client?: API
+): Promise<CentrifugoPresenceResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.serverPresenceCreate(data)
+  return CentrifugoPresenceResponseSchema.parse(response)
+}
+
+
+/**
+ * Get channel presence statistics
+ *
+ * @method POST
+ * @path /cfg/centrifugo/admin/api/server/presence-stats/
+ */
+export async function createCentrifugoAdminApiServerPresenceStatsCreate(  data: CentrifugoPresenceStatsRequestRequest,  client?: API
+): Promise<CentrifugoPresenceStatsResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.serverPresenceStatsCreate(data)
+  return CentrifugoPresenceStatsResponseSchema.parse(response)
+}
+
+
+/**
+ * Get connection token for dashboard
+ *
+ * @method POST
+ * @path /cfg/centrifugo/server/auth/token/
+ */
+export async function createCentrifugoServerAuthTokenCreate(  client?: API
+): Promise<any> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.centrifugoServerAuthTokenCreate()
+  return response
+}
+
+
+/**
+ * List active channels
+ *
+ * @method POST
+ * @path /cfg/centrifugo/server/channels/
+ */
+export async function createCentrifugoServerChannelsCreate(  data: CentrifugoChannelsRequestRequest,  client?: API
+): Promise<CentrifugoChannelsResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.centrifugoServerChannelsCreate(data)
+  return CentrifugoChannelsResponseSchema.parse(response)
+}
+
+
+/**
+ * Get channel history
+ *
+ * @method POST
+ * @path /cfg/centrifugo/server/history/
+ */
+export async function createCentrifugoServerHistoryCreate(  data: CentrifugoHistoryRequestRequest,  client?: API
+): Promise<CentrifugoHistoryResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.centrifugoServerHistoryCreate(data)
+  return CentrifugoHistoryResponseSchema.parse(response)
+}
+
+
+/**
+ * Get Centrifugo server info
+ *
+ * @method POST
+ * @path /cfg/centrifugo/server/info/
+ */
+export async function createCentrifugoServerInfoCreate(  client?: API
+): Promise<CentrifugoInfoResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.centrifugoServerInfoCreate()
+  return CentrifugoInfoResponseSchema.parse(response)
+}
+
+
+/**
+ * Get channel presence
+ *
+ * @method POST
+ * @path /cfg/centrifugo/server/presence/
+ */
+export async function createCentrifugoServerPresenceCreate(  data: CentrifugoPresenceRequestRequest,  client?: API
+): Promise<CentrifugoPresenceResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.centrifugoServerPresenceCreate(data)
+  return CentrifugoPresenceResponseSchema.parse(response)
+}
+
+
+/**
+ * Get channel presence statistics
+ *
+ * @method POST
+ * @path /cfg/centrifugo/server/presence-stats/
+ */
+export async function createCentrifugoServerPresenceStatsCreate(  data: CentrifugoPresenceStatsRequestRequest,  client?: API
+): Promise<CentrifugoPresenceStatsResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_centrifugo_admin_api.centrifugoServerPresenceStatsCreate(data)
+  return CentrifugoPresenceStatsResponseSchema.parse(response)
+}
+
+