@mks2508/coolify-mks-cli-mcp 0.4.3 → 0.6.0

package/src/coolify/types.ts

@@ -12,66 +12,66 @@
  */
 export interface ICoolifyDeployOptions {
   /** Application UUID */
-  uuid?: string
+  uuid?: string;
   /** Application tag */
-  tag?: string
+  tag?: string;
   /** Force rebuild without cache */
-  force?: boolean
+  force?: boolean;
   /** Progress callback for deployment status updates */
-  onProgress?: IProgressCallback
+  onProgress?: IProgressCallback;
 }
 
 /**
  * Application types supported by Coolify.
  */
 export type TCoolifyApplicationType =
-  | 'public'
-  | 'private-github-app'
-  | 'private-deploy-key'
-  | 'dockerfile'
-  | 'docker-image'
-  | 'docker-compose'
+  | "public"
+  | "private-github-app"
+  | "private-deploy-key"
+  | "dockerfile"
+  | "docker-image"
+  | "docker-compose";
 
 /**
  * Options for creating a Coolify application.
  */
 export interface ICoolifyAppOptions {
   /** Application name */
-  name: string
+  name: string;
   /** Application description */
-  description?: string
+  description?: string;
   /** Project UUID */
-  projectUuid: string
+  projectUuid: string;
   /** Environment UUID */
-  environmentUuid: string
+  environmentUuid: string;
   /** Server UUID */
-  serverUuid: string
+  serverUuid: string;
   /** Destination UUID (optional, for specific destination targeting) */
-  destinationUuid?: string
+  destinationUuid?: string;
   /** Application type */
-  type?: TCoolifyApplicationType
+  type?: TCoolifyApplicationType;
   /** GitHub App UUID (required for private-github-app type — get from listGithubApps) */
-  githubAppUuid?: string
+  githubAppUuid?: string;
   /** GitHub repository URL (for git-based apps) */
-  githubRepoUrl?: string
+  githubRepoUrl?: string;
   /** Git branch */
-  branch?: string
+  branch?: string;
   /** Build pack type */
-  buildPack?: 'dockerfile' | 'nixpacks' | 'static' | 'dockercompose'
+  buildPack?: "dockerfile" | "nixpacks" | "static" | "dockercompose";
   /** Ports to expose */
-  portsExposes?: string
+  portsExposes?: string;
   /** Docker image (for docker-image type) */
-  dockerImage?: string
+  dockerImage?: string;
   /** Docker Compose content (for docker-compose type) */
-  dockerCompose?: string
+  dockerCompose?: string;
   /** Docker Compose file location relative to repo root (for dockercompose buildPack) */
-  dockerComposeLocation?: string
+  dockerComposeLocation?: string;
   /** Environment variables */
-  envVars?: Record<string, string>
+  envVars?: Record<string, string>;
   /** Dockerfile location (path relative to repo root, e.g., "apps/haidodocs/Dockerfile") */
-  dockerfileLocation?: string
+  dockerfileLocation?: string;
   /** Base directory for build context (default: "/") */
-  baseDirectory?: string
+  baseDirectory?: string;
 }
 
 /**
@@ -79,33 +79,33 @@ export interface ICoolifyAppOptions {
  */
 export interface ICoolifyUpdateOptions {
   /** Application name */
-  name?: string
+  name?: string;
   /** Application description */
-  description?: string
+  description?: string;
   /** Build pack type */
-  buildPack?: 'dockerfile' | 'nixpacks' | 'static' | 'dockercompose'
+  buildPack?: "dockerfile" | "nixpacks" | "static" | "dockercompose";
   /** Git branch */
-  gitBranch?: string
+  gitBranch?: string;
   /** Ports to expose */
-  portsExposes?: string
+  portsExposes?: string;
   /** Install command (nixpacks) */
-  installCommand?: string
+  installCommand?: string;
   /** Build command */
-  buildCommand?: string
+  buildCommand?: string;
   /** Start command */
-  startCommand?: string
+  startCommand?: string;
   /** Dockerfile location (path relative to repo root, e.g., "apps/haidodocs/Dockerfile") */
-  dockerfileLocation?: string
+  dockerfileLocation?: string;
   /** Base directory for build context (default: "/") */
-  baseDirectory?: string
+  baseDirectory?: string;
   /** Domains/FQDN - comma separated list of domains with protocol (e.g., "https://app.example.com") — NOT for dockercompose apps */
-  domains?: string
+  domains?: string;
   /** Docker Compose domains - JSON object: { "service-name": { "domain": "https://..." } } — for dockercompose apps */
-  dockerComposeDomains?: string
+  dockerComposeDomains?: string;
   /** Force HTTPS redirect */
-  isForceHttpsEnabled?: boolean
+  isForceHttpsEnabled?: boolean;
   /** Enable auto deploy on git push */
-  isAutoDeployEnabled?: boolean
+  isAutoDeployEnabled?: boolean;
 }
 
 /**
@@ -113,9 +113,11 @@ export interface ICoolifyUpdateOptions {
  */
 export interface ICoolifyLogsOptions {
   /** Follow logs in real-time */
-  follow?: boolean
+  follow?: boolean;
   /** Number of lines to retrieve */
-  tail?: number
+  tail?: number;
+  /** Service name for docker-compose apps */
+  serviceName?: string;
 }
 
 /**
@@ -123,13 +125,13 @@ export interface ICoolifyLogsOptions {
  */
 export interface ICoolifyDeployResult {
   /** Whether the deployment started successfully */
-  success: boolean
+  success: boolean;
   /** Deployment UUID */
-  deploymentUuid?: string
+  deploymentUuid?: string;
   /** Resource UUID */
-  resourceUuid?: string
+  resourceUuid?: string;
   /** Error message if failed */
-  error?: string
+  error?: string;
 }
 
 /**
@@ -137,11 +139,11 @@ export interface ICoolifyDeployResult {
  */
 export interface ICoolifyAppResult {
   /** Whether the application was created */
-  success: boolean
+  success: boolean;
   /** Application UUID */
-  uuid?: string
+  uuid?: string;
   /** Error message if failed */
-  error?: string
+  error?: string;
 }
 
 /**
@@ -149,9 +151,9 @@ export interface ICoolifyAppResult {
  */
 export interface ICoolifyDeleteResult {
   /** Whether the deletion was successful */
-  success: boolean
+  success: boolean;
   /** Optional message */
-  message?: string
+  message?: string;
 }
 
 /**
@@ -159,9 +161,9 @@ export interface ICoolifyDeleteResult {
  */
 export interface ICoolifyLogs {
   /** Log lines */
-  logs: string[]
+  logs: string[];
   /** Timestamp of log retrieval */
-  timestamp: string
+  timestamp: string;
 }
 
 /**
@@ -169,27 +171,27 @@ export interface ICoolifyLogs {
  */
 export interface ICoolifyDeployment {
   /** Deployment ID */
-  id: number
+  id: number;
   /** Deployment UUID */
-  uuid: string
+  uuid: string;
   /** Deployment status */
-  status: string
+  status: string;
   /** Application ID */
-  application_id?: number
+  application_id?: number;
   /** Pull request ID if applicable */
-  pull_request_id?: number | null
+  pull_request_id?: number | null;
   /** Force rebuild flag */
-  force_rebuild?: boolean
+  force_rebuild?: boolean;
   /** Commit hash */
-  commit?: string | null
+  commit?: string | null;
   /** Rollback flag */
-  rollback?: boolean
+  rollback?: boolean;
   /** Commit message */
-  commit_message?: string | null
+  commit_message?: string | null;
   /** Creation timestamp */
-  created_at: string
+  created_at: string;
   /** Update timestamp */
-  updated_at: string
+  updated_at: string;
 }
 
 /**
@@ -197,53 +199,53 @@ export interface ICoolifyDeployment {
  */
 export interface ICoolifyApplication {
   /** Application UUID */
-  uuid: string
+  uuid: string;
   /** Application name */
-  name: string
+  name: string;
   /** Application description */
-  description?: string | null
+  description?: string | null;
   /** Current status (e.g., "running:unknown", "stopped") */
-  status: string
+  status: string;
   /** FQDN if configured */
-  fqdn?: string | null
+  fqdn?: string | null;
   /** Git repository (e.g., "MKS2508/repo-name") */
-  git_repository?: string | null
+  git_repository?: string | null;
   /** Git branch */
-  git_branch?: string | null
+  git_branch?: string | null;
   /** Full git URL */
-  git_full_url?: string | null
+  git_full_url?: string | null;
   /** Build pack type */
-  build_pack?: string | null
+  build_pack?: string | null;
   /** Ports exposed */
-  ports_exposes?: string | null
+  ports_exposes?: string | null;
   /** Dockerfile location */
-  dockerfile_location?: string | null
+  dockerfile_location?: string | null;
   /** Base directory */
-  base_directory?: string | null
+  base_directory?: string | null;
   /** Server status (boolean) */
-  server_status?: boolean
+  server_status?: boolean;
   /** Environment ID */
-  environment_id?: number
+  environment_id?: number;
   /** Destination info */
   destination?: {
-    uuid: string
-    name: string
+    uuid: string;
+    name: string;
     server?: {
-      uuid: string
-      name: string
-      ip: string
-    }
-  } | null
+      uuid: string;
+      name: string;
+      ip: string;
+    };
+  } | null;
   /** Install command */
-  install_command?: string | null
+  install_command?: string | null;
   /** Build command */
-  build_command?: string | null
+  build_command?: string | null;
   /** Start command */
-  start_command?: string | null
+  start_command?: string | null;
   /** Creation timestamp */
-  created_at?: string
+  created_at?: string;
   /** Update timestamp */
-  updated_at?: string
+  updated_at?: string;
 }
 
 /**
@@ -251,27 +253,27 @@ export interface ICoolifyApplication {
  */
 export interface ICoolifyServer {
   /** Server UUID */
-  uuid: string
+  uuid: string;
   /** Server name */
-  name: string
+  name: string;
   /** Server description */
-  description?: string | null
+  description?: string | null;
   /** Server IP address */
-  ip?: string
+  ip?: string;
   /** SSH port */
-  port?: number
+  port?: number;
   /** Whether this is the Coolify host */
-  is_coolify_host?: boolean
+  is_coolify_host?: boolean;
   /** Whether server is reachable */
-  is_reachable?: boolean
+  is_reachable?: boolean;
   /** Whether server is usable */
-  is_usable?: boolean
+  is_usable?: boolean;
   /** Proxy configuration */
   proxy?: {
-    redirect_enabled?: boolean
-  } | null
+    redirect_enabled?: boolean;
+  } | null;
   /** Server settings */
-  settings?: Record<string, unknown> | null
+  settings?: Record<string, unknown> | null;
 }
 
 /**
@@ -279,13 +281,13 @@ export interface ICoolifyServer {
  */
 export interface ICoolifyDestination {
   /** Destination UUID */
-  uuid: string
+  uuid: string;
   /** Destination name */
-  name: string
+  name: string;
   /** Network name */
-  network?: string
+  network?: string;
   /** Server UUID */
-  server_uuid?: string
+  server_uuid?: string;
 }
 
 /**
@@ -293,13 +295,13 @@ export interface ICoolifyDestination {
  */
 export interface ICoolifyProject {
   /** Project UUID */
-  uuid: string
+  uuid: string;
   /** Project name */
-  name: string
+  name: string;
   /** Project description */
-  description?: string | null
+  description?: string | null;
   /** Environments in this project */
-  environments?: ICoolifyEnvironment[]
+  environments?: ICoolifyEnvironment[];
 }
 
 /**
@@ -307,19 +309,19 @@ export interface ICoolifyProject {
  */
 export interface ICoolifyEnvironment {
   /** Environment UUID (needed for API calls) */
-  uuid: string
+  uuid: string;
   /** Environment ID */
-  id: number
+  id: number;
   /** Environment name */
-  name: string
+  name: string;
   /** Environment description */
-  description?: string | null
+  description?: string | null;
   /** Project ID */
-  project_id: number
+  project_id: number;
   /** Creation timestamp */
-  created_at?: string
+  created_at?: string;
   /** Update timestamp */
-  updated_at?: string
+  updated_at?: string;
 }
 
 /**
@@ -327,13 +329,13 @@ export interface ICoolifyEnvironment {
  */
 export interface ICoolifyTeam {
   /** Team ID */
-  id: number
+  id: number;
   /** Team name */
-  name: string
+  name: string;
   /** Team description */
-  description?: string | null
+  description?: string | null;
   /** Personal team flag */
-  personal_team?: boolean
+  personal_team?: boolean;
 }
 
 /**
@@ -343,4 +345,97 @@ export interface ICoolifyTeam {
  * @param message - Progress message
  * @param step - Current step identifier
  */
-export type IProgressCallback = (percent: number, message: string, step?: string) => void
+export type IProgressCallback = (
+  percent: number,
+  message: string,
+  step?: string,
+) => void;
+
+/**
+ * Database details from API (snake_case).
+ */
+export interface ICoolifyDatabase {
+  uuid: string;
+  name: string;
+  type: string;
+  status: string;
+  version?: string;
+  description?: string | null;
+  destination?: {
+    uuid: string;
+    name: string;
+    server?: {
+      uuid: string;
+      name: string;
+      ip: string;
+    };
+  } | null;
+}
+
+/**
+ * Service details from API (snake_case).
+ */
+export interface ICoolifyService {
+  uuid: string;
+  name: string;
+  type: string;
+  status: string;
+  version?: string;
+  description?: string | null;
+  project_uuid?: string;
+  environment_uuid?: string;
+  server_uuid?: string;
+}
+
+/**
+ * Private key details from API (snake_case).
+ */
+export interface ICoolifyPrivateKey {
+  uuid: string;
+  name: string;
+  private_key?: string;
+  is_git_related?: boolean;
+  created_at?: string;
+  updated_at?: string;
+}
+
+/**
+ * Database backup details from API (snake_case).
+ */
+export interface ICoolifyDatabaseBackup {
+  uuid: string;
+  name: string;
+  status: string;
+  created_at: string;
+  finished_at?: string;
+  size?: number;
+}
+
+/**
+ * Server resource details from API.
+ */
+export interface ICoolifyServerResource {
+  uuid: string;
+  name: string;
+  type: string;
+  status: string;
+}
+
+/**
+ * Server domain details from API.
+ */
+export interface ICoolifyServerDomain {
+  uuid: string;
+  domain: string;
+  status: string;
+  force_https: boolean;
+}
+
+/**
+ * Coolify version info.
+ */
+export interface ICoolifyVersion {
+  version: string;
+  latest_version?: string;
+  is_latest?: boolean;
+}