@djangocfg/api 1.2.7 → 1.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djangocfg/api",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "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.7",
+    "@djangocfg/typescript-config": "^1.2.8",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "tsup": "^8.5.0",

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

@@ -29,6 +29,8 @@
  * const users = await getUsers({ page: 1 }, api)
  * ```
  */
+import { CommandExecuteRequestRequestSchema, type CommandExecuteRequestRequest } from '../schemas/CommandExecuteRequestRequest.schema'
+import { CommandHelpResponseSchema, type CommandHelpResponse } from '../schemas/CommandHelpResponse.schema'
 import { CommandsSummarySchema, type CommandsSummary } from '../schemas/CommandsSummary.schema'
 import { getAPIInstance } from '../../api-instance'
 
@@ -46,6 +48,34 @@ export async function getDashboardApiCommandsList(  client?: any
 }
 
 
+/**
+ * Get command help
+ *
+ * @method GET
+ * @path /cfg/dashboard/api/commands/{id}/help/
+ */
+export async function getDashboardApiCommandsHelpRetrieve(  id: string,  client?: any
+): Promise<CommandHelpResponse> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_dashboard_commands.dashboardApiCommandsHelpRetrieve(id)
+  return CommandHelpResponseSchema.parse(response)
+}
+
+
+/**
+ * Execute command
+ *
+ * @method POST
+ * @path /cfg/dashboard/api/commands/execute/
+ */
+export async function createDashboardApiCommandsExecuteCreate(  data: CommandExecuteRequestRequest,  client?: any
+): Promise<any> {
+  const api = client || getAPIInstance()
+  const response = await api.cfg_dashboard_commands.dashboardApiCommandsExecuteCreate(data)
+  return response
+}
+
+
 /**
  * Get commands summary
  *

package/src/cfg/generated/_utils/hooks/cfg__dashboard__dashboard_commands.ts

@@ -18,6 +18,8 @@ import useSWR from 'swr'
 import { useSWRConfig } from 'swr'
 import * as Fetchers from '../fetchers/cfg__dashboard__dashboard_commands'
 import type { API } from '../../index'
+import type { CommandExecuteRequestRequest } from '../schemas/CommandExecuteRequestRequest.schema'
+import type { CommandHelpResponse } from '../schemas/CommandHelpResponse.schema'
 import type { CommandsSummary } from '../schemas/CommandsSummary.schema'
 
 /**
@@ -34,6 +36,38 @@ export function useDashboardApiCommandsList(client?: API): ReturnType<typeof use
 }
 
 
+/**
+ * Get command help
+ *
+ * @method GET
+ * @path /cfg/dashboard/api/commands/{id}/help/
+ */
+export function useDashboardApiCommandsHelpRetrieve(id: string, client?: API): ReturnType<typeof useSWR<CommandHelpResponse>> {
+  return useSWR<CommandHelpResponse>(
+    ['cfg-dashboard-api-commands-help', id],
+    () => Fetchers.getDashboardApiCommandsHelpRetrieve(id, client)
+  )
+}
+
+
+/**
+ * Execute command
+ *
+ * @method POST
+ * @path /cfg/dashboard/api/commands/execute/
+ */
+export function useCreateDashboardApiCommandsExecuteCreate() {
+  const { mutate } = useSWRConfig()
+
+  return async (data: CommandExecuteRequestRequest, client?: API): Promise<any> => {
+    const result = await Fetchers.createDashboardApiCommandsExecuteCreate(data, client)
+    // Revalidate related queries
+    mutate('cfg-dashboard-api-commands-execute')
+    return result
+  }
+}
+
+
 /**
  * Get commands summary
  *

package/src/cfg/generated/_utils/schemas/Command.schema.ts

@@ -15,6 +15,8 @@ export const CommandSchema = z.object({
   help: z.string(),
   is_core: z.boolean(),
   is_custom: z.boolean(),
+  is_allowed: z.boolean().optional(),
+  risk_level: z.string().optional(),
 })
 
 /**

package/src/cfg/generated/_utils/schemas/CommandExecuteRequestRequest.schema.ts

@@ -0,0 +1,21 @@
+/**
+ * Zod schema for CommandExecuteRequestRequest
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Request serializer for command execution.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Request serializer for command execution.
+ */
+export const CommandExecuteRequestRequestSchema = z.object({
+  command: z.string().min(1),
+  args: z.array(z.string().min(1)).optional(),
+  options: z.record(z.string(), z.any()).optional(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type CommandExecuteRequestRequest = z.infer<typeof CommandExecuteRequestRequestSchema>

package/src/cfg/generated/_utils/schemas/CommandHelpResponse.schema.ts

@@ -0,0 +1,25 @@
+/**
+ * Zod schema for CommandHelpResponse
+ *
+ * This schema provides runtime validation and type inference.
+ *  * Response serializer for command help.
+ *  */
+import { z } from 'zod'
+
+/**
+ * Response serializer for command help.
+ */
+export const CommandHelpResponseSchema = z.object({
+  status: z.string(),
+  command: z.string(),
+  app: z.string().optional(),
+  help_text: z.string().optional(),
+  is_allowed: z.boolean().optional(),
+  risk_level: z.string().optional(),
+  error: z.string().optional(),
+})
+
+/**
+ * Infer TypeScript type from Zod schema
+ */
+export type CommandHelpResponse = z.infer<typeof CommandHelpResponseSchema>

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

@@ -74,6 +74,8 @@ export * from './ChatSource.schema'
 export * from './ChatSourceRequest.schema'
 export * from './ChunkRevectorizationRequestRequest.schema'
 export * from './Command.schema'
+export * from './CommandExecuteRequestRequest.schema'
+export * from './CommandHelpResponse.schema'
 export * from './CommandsSummary.schema'
 export * from './ConnectionTokenRequestRequest.schema'
 export * from './ConnectionTokenResponse.schema'

package/src/cfg/generated/cfg__dashboard__dashboard_commands/client.ts

@@ -21,6 +21,27 @@ export class CfgDashboardCommands {
     return response;
   }
 
+  /**
+   * Get command help
+   * 
+   * Get detailed help text for a specific Django management command
+   */
+  async dashboardApiCommandsHelpRetrieve(id: string): Promise<Models.CommandHelpResponse> {
+    const response = await this.client.request('GET', `/cfg/dashboard/api/commands/${id}/help/`);
+    return response;
+  }
+
+  /**
+   * Execute command
+   * 
+   * Execute a Django management command and stream output in Server-Sent
+   * Events format
+   */
+  async dashboardApiCommandsExecuteCreate(data: Models.CommandExecuteRequestRequest): Promise<any> {
+    const response = await this.client.request('POST', "/cfg/dashboard/api/commands/execute/", { body: data });
+    return response;
+  }
+
   /**
    * Get commands summary
    * 

package/src/cfg/generated/cfg__dashboard__dashboard_commands/models.ts

@@ -1,3 +1,32 @@
+/**
+ * Response serializer for command help.
+ * 
+ * Response model (includes read-only fields).
+ */
+export interface CommandHelpResponse {
+  status: string;
+  command: string;
+  app?: string;
+  help_text?: string;
+  is_allowed?: boolean;
+  risk_level?: string;
+  error?: string;
+}
+
+/**
+ * Request serializer for command execution.
+ * 
+ * Request model (no read-only fields).
+ */
+export interface CommandExecuteRequestRequest {
+  /** Name of the Django management command */
+  command: string;
+  /** Positional arguments for the command */
+  args?: Array<string>;
+  /** Named options for the command (e.g., {'verbosity': '2'}) */
+  options?: Record<string, any>;
+}
+
 /**
  * Commands summary serializer.
  * 
@@ -23,5 +52,7 @@ export interface Command {
   help: string;
   is_core: boolean;
   is_custom: boolean;
+  is_allowed?: boolean;
+  risk_level?: string;
 }
 

package/src/cfg/generated/schema.ts

@@ -2218,6 +2218,9 @@ export const OPENAPI_SCHEMA = {
           "help": {
             "type": "string"
           },
+          "is_allowed": {
+            "type": "boolean"
+          },
           "is_core": {
             "type": "boolean"
           },
@@ -2226,6 +2229,9 @@ export const OPENAPI_SCHEMA = {
           },
           "name": {
             "type": "string"
+          },
+          "risk_level": {
+            "type": "string"
           }
         },
         "required": [
@@ -2237,6 +2243,64 @@ export const OPENAPI_SCHEMA = {
         ],
         "type": "object"
       },
+      "CommandExecuteRequestRequest": {
+        "description": "Request serializer for command execution.",
+        "properties": {
+          "args": {
+            "description": "Positional arguments for the command",
+            "items": {
+              "minLength": 1,
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "command": {
+            "description": "Name of the Django management command",
+            "minLength": 1,
+            "type": "string"
+          },
+          "options": {
+            "additionalProperties": {},
+            "description": "Named options for the command (e.g., {\u0027verbosity\u0027: \u00272\u0027})",
+            "type": "object"
+          }
+        },
+        "required": [
+          "command"
+        ],
+        "type": "object"
+      },
+      "CommandHelpResponse": {
+        "description": "Response serializer for command help.",
+        "properties": {
+          "app": {
+            "type": "string"
+          },
+          "command": {
+            "type": "string"
+          },
+          "error": {
+            "type": "string"
+          },
+          "help_text": {
+            "type": "string"
+          },
+          "is_allowed": {
+            "type": "boolean"
+          },
+          "risk_level": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "command",
+          "status"
+        ],
+        "type": "object"
+      },
       "CommandsSummary": {
         "description": "Commands summary serializer.",
         "properties": {
@@ -9933,6 +9997,9 @@ export const OPENAPI_SCHEMA = {
           }
         },
         "security": [
+          {
+            "jwtAuth": []
+          },
           {
             "cookieAuth": []
           },
@@ -9947,6 +10014,80 @@ export const OPENAPI_SCHEMA = {
         "x-async-capable": false
       }
     },
+    "/cfg/dashboard/api/commands/execute/": {
+      "post": {
+        "description": "Execute a Django management command and stream output in Server-Sent Events format",
+        "operationId": "cfg_dashboard_api_commands_execute_create",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CommandExecuteRequestRequest"
+              }
+            },
+            "application/x-www-form-urlencoded": {
+              "schema": {
+                "$ref": "#/components/schemas/CommandExecuteRequestRequest"
+              }
+            },
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/CommandExecuteRequestRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Command execution started (SSE stream)"
+                }
+              }
+            },
+            "description": ""
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Invalid request"
+                }
+              }
+            },
+            "description": ""
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Command not allowed"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "jwtAuth": []
+          },
+          {
+            "cookieAuth": []
+          },
+          {
+            "basicAuth": []
+          }
+        ],
+        "summary": "Execute command",
+        "tags": [
+          "Dashboard - Commands"
+        ],
+        "x-async-capable": false
+      }
+    },
     "/cfg/dashboard/api/commands/summary/": {
       "get": {
         "description": "Retrieve commands summary with statistics and categorization",
@@ -9964,6 +10105,9 @@ export const OPENAPI_SCHEMA = {
           }
         },
         "security": [
+          {
+            "jwtAuth": []
+          },
           {
             "cookieAuth": []
           },
@@ -9978,6 +10122,50 @@ export const OPENAPI_SCHEMA = {
         "x-async-capable": false
       }
     },
+    "/cfg/dashboard/api/commands/{id}/help/": {
+      "get": {
+        "description": "Get detailed help text for a specific Django management command",
+        "operationId": "cfg_dashboard_api_commands_help_retrieve",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommandHelpResponse"
+                }
+              }
+            },
+            "description": ""
+          }
+        },
+        "security": [
+          {
+            "jwtAuth": []
+          },
+          {
+            "cookieAuth": []
+          },
+          {
+            "basicAuth": []
+          }
+        ],
+        "summary": "Get command help",
+        "tags": [
+          "Dashboard - Commands"
+        ],
+        "x-async-capable": false
+      }
+    },
     "/cfg/dashboard/api/overview/overview/": {
       "get": {
         "description": "Retrieve complete dashboard data including stats, health, actions, and metrics",