Skip to content

The fastest, cheapest, most efficient open-source agent harness. Run more than 500 agents on a $10 VPS.

3.6 KB
Raw Blame
export type ChannelType =
  | 'telegram'
  | 'discord'
  | 'web'
  | 'lark'
  | 'dingtalk'
  | 'email'
  | 'mcp'
  | 'yuanbao';

/** Every valid {@link ChannelType}, for runtime validation of values that arrive
 *  from the core (which is typed `string`). `satisfies` keeps this list in
 *  lockstep with the `ChannelType` union — adding a member there without updating
 *  here is a compile error. */
const KNOWN_CHANNEL_TYPES = [
  'telegram',
  'discord',
  'web',
  'lark',
  'dingtalk',
  'email',
  'mcp',
  'yuanbao',
] as const satisfies readonly ChannelType[];

/** Runtime guard: narrow an untrusted value to a known `ChannelType`. Use before
 *  coercing core-provided `channel_id` / `active_channel` strings so unknown
 *  channels never leak into Redux/API consumers (issue #3794 review). */
export function isChannelType(value: unknown): value is ChannelType {
  return typeof value === 'string' && (KNOWN_CHANNEL_TYPES as readonly string[]).includes(value);
}

export type ChannelAuthMode = 'managed_dm' | 'oauth' | 'bot_token' | 'api_key';

export type ChannelConnectionStatus = 'connected' | 'connecting' | 'disconnected' | 'error';

export interface ChannelConnection {
  channel: ChannelType;
  authMode: ChannelAuthMode;
  status: ChannelConnectionStatus;
  selectedDefault: boolean;
  lastError?: string;
  capabilities: string[];
  updatedAt: string;
}

export interface ChannelConnectionsByMode {
  managed_dm?: ChannelConnection;
  oauth?: ChannelConnection;
  bot_token?: ChannelConnection;
  api_key?: ChannelConnection;
}

export interface ChannelConnectionsState {
  schemaVersion: number;
  migrationCompleted: boolean;
  defaultMessagingChannel: ChannelType;
  connections: Record<ChannelType, ChannelConnectionsByMode>;
}

// --- Backend-driven definitions (from openhuman.channels_list) ---

export interface FieldRequirement {
  key: string;
  label: string;
  field_type: string; // "string" | "secret" | "boolean"
  required: boolean;
  placeholder: string;
  /** Default state for boolean fields; seeds the checkbox so its visible state
   *  matches what persists when untouched (e.g. smtp_tls defaults on). */
  default_bool?: boolean;
}

export interface AuthModeSpec {
  mode: ChannelAuthMode;
  description: string;
  fields: FieldRequirement[];
  auth_action?: string; // e.g. "telegram_managed_dm", "discord_oauth"
}

export type ChannelCapability =
  | 'send_text'
  | 'send_rich_text'
  | 'receive_text'
  | 'typing'
  | 'draft_updates'
  | 'threaded_replies'
  | 'file_attachments'
  | 'reactions';

export interface ChannelDefinition {
  id: string;
  display_name: string;
  description: string;
  icon: string;
  auth_modes: AuthModeSpec[];
  capabilities: ChannelCapability[];
}

export interface ChannelStatusEntry {
  channel_id: string;
  auth_mode: ChannelAuthMode;
  connected: boolean;
  has_credentials: boolean;
  /** Live failure reason from the supervised listener when the channel is
   *  configured but its runtime listener is currently failing (issue #3712).
   *  Absent when healthy, still starting, or for listener-less modes. */
  error?: string;
}

export interface ChannelConnectionResult {
  status: string; // "connected" | "pending_auth"
  restart_required: boolean;
  auth_action?: string;
  message?: string;
}

// --- Discord guild/channel discovery types ---

export interface DiscordGuild {
  id: string;
  name: string;
  icon: string | null;
}

export interface DiscordTextChannel {
  id: string;
  name: string;
  type: number;
  position: number;
  parent_id: string | null;
}

export interface BotPermissionCheck {
  can_view_channel: boolean;
  can_send_messages: boolean;
  can_read_message_history: boolean;
  missing_permissions: string[];
}