@compilr-dev/sdk 0.1.28 → 0.2.1

package/dist/team/types.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Multi-Agent Types
+ *
+ * Type definitions for the multi-agent team system.
+ */
+import type { AgentConfig, AgentState } from '@compilr-dev/agents';
+import type { ModelTier } from '../models/index.js';
+export type ToolProfile = 'full' | 'read-only' | 'developer' | 'security' | 'docs' | 'devops' | 'qa' | 'architect' | 'planner' | 'analyst' | 'custom';
+/**
+ * Information about a background agent session.
+ * Used by /bg overlay to display status.
+ */
+export interface BackgroundSessionInfo {
+    /** Agent ID */
+    agentId: string;
+    /** Agent display name */
+    displayName: string;
+    /** Agent mascot */
+    mascot: string;
+    /** Current action being performed */
+    currentAction: string | null;
+    /** Whether the agent is blocked waiting for user input */
+    isBlocked: boolean;
+    /** Number of pending requests from this agent */
+    pendingCount: number;
+    /** Number of messages queued for this agent */
+    queuedCount: number;
+}
+/**
+ * Mascot expressions for visual differentiation of agents
+ */
+export type MascotExpression = '[•_•]' | '[◈_◈]' | '[▣_▣]' | '[◉_◉]' | '[▲_▲]' | '[◆_◆]' | '[○_○]' | '[◇_◇]' | '[□_□]';
+/**
+ * Predefined agent roles with default configurations
+ */
+export type AgentRole = 'default' | 'pm' | 'arch' | 'qa' | 'dev' | 'ops' | 'docs' | 'ba' | 'custom';
+/**
+ * List of predefined role IDs (for validation against custom agent IDs)
+ */
+export declare const PREDEFINED_ROLE_IDS: readonly ["default", "pm", "arch", "qa", "dev", "ops", "docs", "ba"];
+/**
+ * Role metadata for predefined roles
+ */
+export interface RoleMetadata {
+    displayName: string;
+    mascot: MascotExpression;
+    description: string;
+    defaultSystemPromptAddition?: string;
+    /** Use minimal system prompt - skip all modules, just use role prompt (for testing) */
+    useMinimalSystemPrompt?: boolean;
+    /** Skip all tool registration - agent has no tools (for testing role identity) */
+    noTools?: boolean;
+    /** Default tool profile for this role */
+    defaultToolProfile?: ToolProfile;
+    /** Default model tier for this role */
+    defaultModelTier?: ModelTier;
+}
+/**
+ * Role expertise keywords for team awareness
+ * Used in the team roster to help agents understand each other's strengths
+ */
+export declare const ROLE_EXPERTISE: Record<AgentRole, string[]>;
+/**
+ * Predefined role configurations
+ */
+export declare const ROLE_METADATA: Record<AgentRole, RoleMetadata>;
+/**
+ * Configuration for creating a team agent
+ */
+export interface TeamAgentConfig {
+    /**
+     * Unique identifier for the agent (e.g., 'pm', 'arch', 'qa')
+     * Used for $name switching
+     */
+    id: string;
+    /**
+     * Display name shown in UI (e.g., 'Technical PM')
+     */
+    displayName: string;
+    /**
+     * Mascot expression for visual differentiation
+     */
+    mascot: MascotExpression;
+    /**
+     * Role type (for presets)
+     */
+    role: AgentRole;
+    /**
+     * Optional description of the agent's purpose
+     */
+    description?: string;
+    /**
+     * System prompt addition specific to this agent
+     * Appended to the base system prompt
+     */
+    systemPromptAddition?: string;
+    /**
+     * Use minimal system prompt - skip all modules, just use role prompt
+     */
+    useMinimalSystemPrompt?: boolean;
+    /**
+     * Skip all tool registration - agent has no tools
+     */
+    noTools?: boolean;
+    /**
+     * Tool filter - which tools this agent can use
+     * If not specified, inherits all tools from the team
+     */
+    toolFilter?: string[];
+    /**
+     * Tool profile name (for display purposes)
+     * Shows which profile was selected when creating the agent
+     */
+    toolProfile?: ToolProfile;
+    /**
+     * Enabled skills for this agent
+     * Empty array means all skills, non-empty means filtered
+     */
+    enabledSkills?: string[];
+    /**
+     * Model tier for this agent (fast/balanced/powerful)
+     * Determines which model is used based on provider
+     * If not specified, uses role default or 'balanced'
+     */
+    modelTier?: ModelTier;
+    /**
+     * Auto-approve handoffs from this agent without showing the approval overlay.
+     * Default: false (user must approve each handoff)
+     */
+    autoApproveHandoff?: boolean;
+    /**
+     * Base agent configuration (provider, model, etc.)
+     * If not specified, inherits from team defaults
+     */
+    agentConfig?: Partial<AgentConfig>;
+}
+/**
+ * Serialized team agent state for persistence
+ */
+export interface SerializedTeamAgent {
+    id: string;
+    displayName: string;
+    mascot: MascotExpression;
+    role: AgentRole;
+    description?: string;
+    systemPromptAddition?: string;
+    useMinimalSystemPrompt?: boolean;
+    noTools?: boolean;
+    toolFilter?: string[];
+    toolProfile?: ToolProfile;
+    enabledSkills?: string[];
+    modelTier?: ModelTier;
+    autoApproveHandoff?: boolean;
+    agentState?: AgentState;
+}
+/**
+ * Team metadata for persistence
+ */
+export interface TeamMetadata {
+    /**
+     * Team name
+     */
+    name: string;
+    /**
+     * Currently active agent ID
+     */
+    activeAgentId: string;
+    /**
+     * Coordinator agent ID (optional)
+     * If set, all messages go through coordinator first
+     */
+    coordinatorId?: string;
+    /**
+     * List of agent IDs in the team
+     */
+    agentIds: string[];
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last updated timestamp
+     */
+    updatedAt: string;
+}
+/**
+ * Full serialized team state for persistence
+ */
+export interface SerializedTeam {
+    metadata: TeamMetadata;
+    agents: SerializedTeamAgent[];
+}
+/**
+ * Event types for team operations
+ */
+export type TeamEventType = 'agent:added' | 'agent:removed' | 'agent:switched' | 'agent:switch_warning' | 'agent:collision' | 'agent:message' | 'team:checkpoint' | 'team:restored' | 'team:reset';
+/**
+ * Team event payload
+ */
+export interface TeamEvent {
+    type: TeamEventType;
+    agentId?: string;
+    previousAgentId?: string;
+    /** Original ID before collision resolution (for agent:collision events) */
+    originalId?: string;
+    message?: string;
+}
+/**
+ * Team event handler
+ */
+export type TeamEventHandler = (event: TeamEvent) => void;