LangBot/web/src/app/infra/entities/api/index.ts

import { IDynamicFormItemSchema } from '@/app/infra/entities/form/dynamic';
import { PipelineConfigTab } from '@/app/infra/entities/pipeline';
import { I18nObject } from '@/app/infra/entities/common';
import { Message } from '@/app/infra/entities/message';
import { Plugin, PluginV4 } from '@/app/infra/entities/plugin';

export interface ApiResponse<T> {
  code: number;
  data: T;
  msg: string;
}

export interface AsyncTaskCreatedResp {
  task_id: number;
}

export interface ApiRespProviderRequesters {
  requesters: Requester[];
}

export interface ApiRespProviderRequester {
  requester: Requester;
}

export interface Requester {
  name: string;
  label: I18nObject;
  description: I18nObject;
  icon?: string;
  spec: {
    config: IDynamicFormItemSchema[];
    provider_category: string;
    support_type?: string[];
    alias?: string;
  };
}

export interface ApiRespProviderLLMModels {
  models: LLMModel[];
}

export interface ApiRespProviderLLMModel {
  model: LLMModel;
}

export interface ModelProvider {
  uuid: string;
  name: string;
  requester: string;
  base_url: string;
  api_keys: string[];
  llm_count?: number;
  embedding_count?: number;
  rerank_count?: number;
  created_at?: string;
  updated_at?: string;
}

export interface ApiRespModelProviders {
  providers: ModelProvider[];
}

export interface ApiRespModelProvider {
  provider: ModelProvider;
}

export interface ScannedProviderModel {
  id: string;
  name: string;
  type: 'llm' | 'embedding';
  abilities?: string[];
  display_name?: string;
  description?: string;
  context_length?: number | null;
  owned_by?: string;
  input_modalities?: string[];
  output_modalities?: string[];
  already_added: boolean;
}

export interface ProviderScanDebugInfo {
  request?: {
    method?: string;
    url?: string;
    headers?: Record<string, string>;
  };
  response?: unknown;
}

export interface ApiRespScannedProviderModels {
  models: ScannedProviderModel[];
  debug?: ProviderScanDebugInfo;
}

export interface LLMModel {
  uuid: string;
  name: string;
  provider_uuid: string;
  provider?: ModelProvider;
  abilities?: string[];
  context_length?: number | null;
  extra_args?: object;
}

export interface ApiRespProviderEmbeddingModels {
  models: EmbeddingModel[];
}

export interface ApiRespProviderEmbeddingModel {
  model: EmbeddingModel;
}

export interface EmbeddingModel {
  uuid: string;
  name: string;
  provider_uuid: string;
  provider?: ModelProvider;
  extra_args?: object;
}

export interface ApiRespProviderRerankModels {
  models: RerankModel[];
}

export interface ApiRespProviderRerankModel {
  model: RerankModel;
}

export interface RerankModel {
  uuid: string;
  name: string;
  provider_uuid: string;
  provider?: ModelProvider;
  extra_args?: object;
}

export interface ApiRespPipelines {
  pipelines: Pipeline[];
}

export type AgentKind = 'agent' | 'pipeline';

export interface AgentCapability {
  supported_event_patterns: string[];
  message_only: boolean;
}

export interface Agent {
  uuid?: string;
  name: string;
  description: string;
  emoji?: string;
  kind: AgentKind;
  component_ref?: string | null;
  config?: Record<string, unknown>;
  enabled?: boolean;
  supported_event_patterns?: string[];
  capability?: AgentCapability;
  created_at?: string;
  updated_at?: string;
}

export interface ApiRespAgents {
  agents: Agent[];
}

export interface ApiRespAgent {
  agent: Agent;
}

export interface GetAgentMetadataResponseData {
  runner_config?: PipelineConfigTab;
  kinds: Array<{
    name: AgentKind;
    supported_event_patterns: string[];
    message_only: boolean;
  }>;
}

export interface Pipeline {
  uuid?: string;
  name: string;
  description: string;
  for_version?: string;
  config: object;
  stages?: string[];
  is_default?: boolean;
  created_at?: string;
  updated_at?: string;
  emoji?: string;
}

export interface ApiRespPlatformAdapters {
  adapters: Adapter[];
}

export interface ApiRespPlatformAdapter {
  adapter: Adapter;
}

export interface Adapter {
  name: string;
  label: I18nObject;
  description: I18nObject;
  icon?: string;
  spec: {
    categories?: string[];
    legacy?: boolean;
    help_links?: Record<string, string>;
    supported_events?: string[];
    supported_apis?: string[];
    config: IDynamicFormItemSchema[];
  };
}

export interface ApiRespPlatformBots {
  bots: Bot[];
}

export interface ApiRespPlatformBot {
  bot: Bot;
}

export interface Bot {
  uuid?: string;
  name: string;
  description: string;
  enable?: boolean;
  adapter: string;
  adapter_config: object;
  use_pipeline_name?: string;
  use_pipeline_uuid?: string;
  pipeline_routing_rules?: PipelineRoutingRule[];
  event_bindings?: EventBinding[];
  created_at?: string;
  updated_at?: string;
  adapter_runtime_values?: object;
}

export type RoutingRuleOperator =
  | 'eq'
  | 'neq'
  | 'contains'
  | 'not_contains'
  | 'starts_with'
  | 'regex';

export interface PipelineRoutingRule {
  type:
    | 'launcher_type'
    | 'launcher_id'
    | 'message_content'
    | 'message_has_element';
  operator: RoutingRuleOperator;
  value: string;
  pipeline_uuid: string;
}

export interface EventBinding {
  id?: string;
  event_pattern: string;
  target_type: 'agent' | 'pipeline' | 'discard';
  target_uuid: string;
  filters?: Array<Record<string, unknown>>;
  priority: number;
  enabled: boolean;
  description?: string;
  order?: number;
}

export interface ApiRespKnowledgeBases {
  bases: KnowledgeBase[];
}

export interface ApiRespKnowledgeBase {
  base: KnowledgeBase;
}

export interface KnowledgeBase {
  uuid?: string;
  name: string;
  description: string;
  created_at?: string;
  updated_at?: string;
  emoji?: string;
  // New unified fields
  knowledge_engine_plugin_id?: string;
  creation_settings?: Record<string, unknown>;
  retrieval_settings?: Record<string, unknown>;
  knowledge_engine?: KnowledgeEngineInfo;
}

// Knowledge Engine types
export interface KnowledgeEngineInfo {
  plugin_id: string | null;
  name: I18nObject;
  capabilities: string[];
}

export interface KnowledgeEngine {
  plugin_id: string;
  name: I18nObject;
  description?: I18nObject;
  capabilities: string[];
  // Schema format: Array of form field definitions (IDynamicFormItemSchema-like)
  // Each item: { name, label, type, required, default, description?, options? }
  creation_schema?: unknown[];
  retrieval_schema?: unknown[];
}

export interface ApiRespKnowledgeEngines {
  engines: KnowledgeEngine[];
}

export interface ParserInfo {
  plugin_id: string;
  name: I18nObject;
  description?: I18nObject;
  supported_mime_types: string[];
}

export interface ApiRespParsers {
  parsers: ParserInfo[];
}

export interface ApiRespKnowledgeBaseFiles {
  files: KnowledgeBaseFile[];
}

export interface KnowledgeBaseFile {
  uuid: string;
  file_name: string;
  status: string;
}

// plugins
export interface ApiRespPlugins {
  plugins: Plugin[];
}

export type ExtensionItem =
  | { type: 'plugin'; plugin: Plugin }
  | { type: 'mcp'; server: MCPServer }
  | { type: 'skill'; skill: Skill };

export interface ApiRespExtensions {
  extensions: ExtensionItem[];
}

export interface ApiRespPlugin {
  plugin: Plugin;
}

// export interface Plugin {
//   author: string;
//   name: string;
//   description: I18nLabel;
//   label: I18nLabel;
//   version: string;
//   enabled: boolean;
//   priority: number;
//   status: string;
//   tools: object[];
//   event_handlers: object;
//   main_file: string;
//   pkg_path: string;
//   repository: string;
//   config_schema: IDynamicFormItemSchema[];
// }

export interface ApiRespPluginConfig {
  config: object;
}

export interface PluginReorderElement {
  author: string;
  name: string;
  priority: number;
}

// system
export interface SystemLimitation {
  max_bots: number;
  max_pipelines: number;
  max_extensions: number;
  /** When non-empty, every pipeline is forced to this Box sandbox-scope
   *  template (e.g. ``{global}``) and the per-pipeline "Sandbox Scope"
   *  selector is locked. Used by SaaS deployments. Empty = no restriction. */
  force_box_session_id_template?: string;
}

export interface WizardProgress {
  step: number;
  selected_adapter: string | null;
  created_bot_uuid: string | null;
  bot_saved: boolean;
  selected_runner: string | null;
}

export interface ApiRespSystemInfo {
  debug: boolean;
  version: string;
  edition: string;
  cloud_service_url: string;
  enable_marketplace: boolean;
  allow_modify_login_info: boolean;
  disable_models_service: boolean;
  limitation: SystemLimitation;
  /** Public outbound IPs of the deployment (``system.outbound_ips`` in
   *  config.yaml). Shown on adapter config forms whose platform requires
   *  trusted-IP / IP-whitelist settings. Empty = not configured. */
  outbound_ips: string[];
  wizard_status: string; // 'none' | 'skipped' | 'completed'
  wizard_progress: WizardProgress | null;
}

export interface RagMigrationStatusResp {
  needed: boolean;
  internal_kb_count: number;
  external_kb_count: number;
}

export interface ApiRespPluginSystemStatus {
  is_enable: boolean;
  is_connected: boolean;
  plugin_connector_error: string;
}

export interface ApiRespBoxStatus {
  available: boolean;
  /** UI hint: hide the Box runtime status surface for this deployment. */
  hidden?: boolean;
  /** Whether ``box.enabled`` is true in config. When false, the sandbox
   * is deliberately disabled — distinct from "configured but failed". */
  enabled?: boolean;
  profile: string;
  recent_error_count: number;
  connector_error?: string;
  backend?: {
    name: string;
    available: boolean;
  };
  active_sessions?: number;
  managed_processes?: number;
  session_ttl_sec?: number;
}

export interface BoxSessionInfo {
  session_id: string;
  backend_name: string;
  image: string;
  network: string;
  host_path: string | null;
  host_path_mode: string;
  mount_path: string;
  cpus: number;
  memory_mb: number;
  created_at: string;
  last_used_at: string;
}

export interface ApiRespAsyncTasks {
  tasks: AsyncTask[];
}

export interface AsyncTaskRuntimeInfo {
  done: boolean;
  exception?: string;
  result?: object;
  state: string;
}

export interface AsyncTaskTaskContext {
  current_action: string;
  log: string;
  metadata?: Record<string, unknown>;
}

export interface AsyncTask {
  id: number;
  kind: string;
  name: string;
  label: string;
  task_type: string; // system or user
  runtime: AsyncTaskRuntimeInfo;
  task_context: AsyncTaskTaskContext;
}

export interface ApiRespUserToken {
  token: string;
}

export interface ApiRespMarketplacePlugins {
  plugins: PluginV4[];
  total: number;
}

export interface ApiRespMarketplacePluginDetail {
  plugin: PluginV4;
}

interface GetPipelineConfig {
  ai: object;
  output: object;
  safety: object;
  trigger: object;
}

interface GetPipeline {
  config: GetPipelineConfig;
  created_at: string;
  description: string;
  for_version: string;
  is_default: boolean;
  name: string;
  stages: string[];
  updated_at: string;
  uuid: string;
  emoji?: string;
}

export interface GetPipelineResponseData {
  pipeline: GetPipeline;
}

export interface GetPipelineMetadataResponseData {
  configs: PipelineConfigTab[];
}

export interface ApiRespWebChatMessage {
  message: Message;
}

export interface ApiRespWebChatMessages {
  messages: Message[];
}

export interface RetrieveResultContent {
  type: 'text' | 'image_url' | 'image_base64' | 'file_url';
  text?: string;
  file_name?: string;
  file_url?: string;
  image_url?: string;
  image_base64?: string;
}

export interface RetrieveResult {
  id: string;
  content?: RetrieveResultContent[];
  metadata: {
    file_id?: string;
    text?: string;
    uuid?: string;
    [key: string]: unknown;
  };
  distance: number;
}

export interface ApiRespKnowledgeBaseRetrieve {
  results: RetrieveResult[];
}

// MCP
export interface ApiRespMCPServers {
  servers: MCPServer[];
}

export interface ApiRespMCPServer {
  server: MCPServer;
}

export interface MCPServerExtraArgsSSE {
  url: string;
  headers: Record<string, string>;
  timeout: number;
  ssereadtimeout: number;
}

export interface MCPServerExtraArgsStdio {
  command: string;
  args: string[];
  env: Record<string, string>;
}

export interface MCPServerExtraArgsHttp {
  url: string;
  headers: Record<string, string>;
  timeout: number;
}

// "remote" mode: the user only supplies a URL; the backend auto-detects the
// transport (Streamable HTTP first, falling back to legacy SSE). headers /
// timeout are optional advanced settings.
export interface MCPServerExtraArgsRemote {
  url: string;
  headers?: Record<string, string>;
  timeout?: number;
}

export enum MCPSessionStatus {
  CONNECTING = 'connecting',
  CONNECTED = 'connected',
  ERROR = 'error',
}

export interface MCPServerRuntimeInfo {
  status: MCPSessionStatus;
  error_message?: string;
  /** Stage at which the session failed. Frontends key off this to render
   *  a localized actionable message instead of the raw ``error_message``.
   *  Notable values: ``box_unavailable`` (stdio MCP refused because Box is
   *  disabled / unreachable). See ``MCPSessionErrorPhase`` (backend). */
  error_phase?: string;
  retry_count?: number;
  tool_count: number;
  tools: MCPTool[];
  /** Optional ``box_session_id`` / ``box_enabled`` set when this stdio
   *  server runs inside Box. Absent when Box is unavailable. */
  box_session_id?: string;
  box_enabled?: boolean;
  resource_count: number;
  resources: MCPResource[];
  resource_template_count?: number;
  resource_templates?: MCPResourceTemplate[];
  resource_capabilities?: Record<string, unknown>;
}

export type MCPServer =
  | {
      uuid?: string;
      name: string;
      mode: 'sse';
      enable: boolean;
      extra_args: MCPServerExtraArgsSSE;
      runtime_info?: MCPServerRuntimeInfo;
      readme?: string;
      created_at?: string;
      updated_at?: string;
    }
  | {
      uuid?: string;
      name: string;
      mode: 'http';
      enable: boolean;
      extra_args: MCPServerExtraArgsHttp;
      runtime_info?: MCPServerRuntimeInfo;
      readme?: string;
      created_at?: string;
      updated_at?: string;
    }
  | {
      uuid?: string;
      name: string;
      mode: 'remote';
      enable: boolean;
      extra_args: MCPServerExtraArgsRemote;
      runtime_info?: MCPServerRuntimeInfo;
      readme?: string;
      created_at?: string;
      updated_at?: string;
    }
  | {
      uuid?: string;
      name: string;
      mode: 'stdio';
      enable: boolean;
      extra_args: MCPServerExtraArgsStdio;
      runtime_info?: MCPServerRuntimeInfo;
      readme?: string;
      created_at?: string;
      updated_at?: string;
    };

export interface MCPTool {
  name: string;
  description: string;
  parameters?: object;
}

export interface MCPResource {
  uri: string;
  name: string;
  title?: string;
  description: string;
  mime_type: string;
  size?: number;
  icons?: object[];
  annotations?: Record<string, unknown>;
  _meta?: Record<string, unknown>;
}

export interface MCPResourceTemplate {
  uri_template: string;
  name: string;
  title?: string;
  description: string;
  mime_type: string;
  icons?: object[];
  annotations?: Record<string, unknown>;
  _meta?: Record<string, unknown>;
}

export interface MCPResourceContent {
  uri: string;
  mime_type: string;
  type: 'text' | 'blob';
  text?: string;
  blob?: string | null;
  bytes?: number;
  truncated?: boolean;
  binary_omitted?: boolean;
  _meta?: Record<string, unknown>;
}

export interface ApiRespMCPResources {
  resources: MCPResource[];
  resource_templates?: MCPResourceTemplate[];
  resource_capabilities?: Record<string, unknown>;
}

export interface ApiRespMCPResourceContents {
  contents: MCPResourceContent[];
  server_name?: string;
  server_uuid?: string;
  uri?: string;
  source?: string;
  bytes?: number;
  truncated?: boolean;
  cache_hit?: boolean;
  warnings?: string[];
}

export interface PluginTool {
  name: string;
  description: string;
  human_desc: string;
  parameters: object;
  source?: 'builtin' | 'plugin' | 'mcp' | 'skill';
  source_name?: string;
  source_id?: string;
}

export interface ApiRespTools {
  tools: PluginTool[];
}

export interface ApiRespToolDetail {
  tool: PluginTool;
}

// Skills
export interface Skill {
  name: string;
  display_name?: string;
  description: string;
  instructions?: string;
  package_root?: string;
  is_builtin?: boolean;
  created_at?: string;
  updated_at?: string;
}

export interface ApiRespSkills {
  skills: Skill[];
}

export interface ApiRespSkill {
  skill: Skill;
}