@swarmclawai/swarmclaw 1.2.6 → 1.2.8

package/src/types/mission.ts

@@ -0,0 +1,185 @@
+export type MissionSource =
+  | 'chat'
+  | 'connector'
+  | 'heartbeat'
+  | 'main-loop-followup'
+  | 'task'
+  | 'schedule'
+  | 'delegation'
+  | 'manual'
+
+export type MissionStatus = 'active' | 'waiting' | 'completed' | 'failed' | 'cancelled'
+export type MissionPhase = 'intake' | 'planning' | 'dispatching' | 'executing' | 'verifying' | 'waiting' | 'completed' | 'failed'
+export type MissionWaitKind =
+  | 'human_reply'
+  | 'approval'
+  | 'external_dependency'
+  | 'provider'
+  | 'blocked_task'
+  | 'blocked_mission'
+  | 'scheduled'
+  | 'other'
+
+export type MissionPlannerDecision =
+  | 'dispatch_task'
+  | 'dispatch_session_turn'
+  | 'spawn_child_mission'
+  | 'wait'
+  | 'verify_now'
+  | 'complete_candidate'
+  | 'replan'
+  | 'fail_terminal'
+  | 'cancel'
+
+export type MissionVerificationVerdict =
+  | 'continue'
+  | 'waiting'
+  | 'completed'
+  | 'failed'
+  | 'replan'
+
+export type MissionSourceRef =
+  | { kind: 'chat'; sessionId: string; messageId?: string | null }
+  | { kind: 'connector'; sessionId: string; connectorId: string; channelId: string; threadId?: string | null }
+  | { kind: 'schedule'; scheduleId: string; recurring: boolean }
+  | { kind: 'task'; taskId: string }
+  | { kind: 'delegation'; parentMissionId: string; backend?: 'agent' | 'codex' | 'claude' | 'opencode' | 'gemini' | null }
+  | { kind: 'heartbeat'; sessionId: string }
+  | { kind: 'manual' }
+
+export interface MissionWaitState {
+  kind: MissionWaitKind
+  reason: string
+  approvalId?: string | null
+  untilAt?: number | null
+  dependencyTaskId?: string | null
+  dependencyMissionId?: string | null
+  providerKey?: string | null
+}
+
+export interface MissionControllerState {
+  leaseId?: string | null
+  leaseExpiresAt?: number | null
+  tickRequestedAt?: number | null
+  tickReason?: string | null
+  plannerRunId?: string | null
+  verifierRunId?: string | null
+  activeRunId?: string | null
+  currentTaskId?: string | null
+  currentChildMissionId?: string | null
+  pendingWakeId?: string | null
+  attemptCount?: number
+  lastEvidenceAt?: number | null
+}
+
+export interface MissionPlannerState {
+  lastDecision?: MissionPlannerDecision | null
+  lastPlannedAt?: number | null
+  planSummary?: string | null
+}
+
+export interface MissionVerificationState {
+  candidate: boolean
+  requiredTaskIds?: string[]
+  requiredChildMissionIds?: string[]
+  requiredArtifacts?: string[]
+  evidenceSummary?: string | null
+  lastVerdict?: MissionVerificationVerdict | null
+  lastVerifiedAt?: number | null
+}
+
+export interface MissionSummary {
+  id: string
+  objective: string
+  status: MissionStatus
+  phase: MissionPhase
+  source: MissionSource
+  currentStep?: string | null
+  waitingReason?: string | null
+  sessionId?: string | null
+  agentId?: string | null
+  projectId?: string | null
+  parentMissionId?: string | null
+  rootMissionId?: string | null
+  taskIds?: string[]
+  openTaskCount?: number
+  completedTaskCount?: number
+  childCount?: number
+  sourceRef?: MissionSourceRef
+  updatedAt: number
+}
+
+export interface Mission {
+  id: string
+  source: MissionSource
+  sourceRef?: MissionSourceRef
+  objective: string
+  successCriteria?: string[]
+  status: MissionStatus
+  phase: MissionPhase
+  sessionId?: string | null
+  agentId?: string | null
+  projectId?: string | null
+  rootMissionId?: string | null
+  parentMissionId?: string | null
+  childMissionIds?: string[]
+  dependencyMissionIds?: string[]
+  dependencyTaskIds?: string[]
+  taskIds?: string[]
+  rootTaskId?: string | null
+  currentStep?: string | null
+  plannerSummary?: string | null
+  verifierSummary?: string | null
+  blockerSummary?: string | null
+  waitState?: MissionWaitState | null
+  controllerState?: MissionControllerState
+  plannerState?: MissionPlannerState
+  verificationState?: MissionVerificationState
+  lastRunId?: string | null
+  sourceRunId?: string | null
+  sourceMessage?: string | null
+  createdAt: number
+  updatedAt: number
+  lastActiveAt?: number | null
+  completedAt?: number | null
+  failedAt?: number | null
+  cancelledAt?: number | null
+}
+
+export type MissionEventType =
+  | 'created'
+  | 'source_triggered'
+  | 'attached'
+  | 'planner_decision'
+  | 'dispatch_started'
+  | 'task_linked'
+  | 'task_started'
+  | 'task_completed'
+  | 'task_failed'
+  | 'child_created'
+  | 'child_completed'
+  | 'child_failed'
+  | 'run_result'
+  | 'verifier_decision'
+  | 'waiting'
+  | 'resumed'
+  | 'replanned'
+  | 'completed'
+  | 'failed'
+  | 'cancelled'
+  | 'interrupted'
+  | 'operator_action'
+  | 'status_change'
+
+export interface MissionEvent {
+  id: string
+  missionId: string
+  type: MissionEventType
+  source: MissionSource | 'system'
+  summary: string
+  data?: Record<string, unknown> | null
+  sessionId?: string | null
+  taskId?: string | null
+  runId?: string | null
+  createdAt: number
+}

package/src/types/protocol.ts

@@ -0,0 +1,422 @@
+import type { MessageToolEvent } from './message'
+
+// --- Structured Session Runs / Protocols ---
+
+export type ProtocolRunStatus = 'draft' | 'running' | 'waiting' | 'paused' | 'completed' | 'failed' | 'cancelled' | 'archived'
+
+export type ProtocolPhaseKind =
+  | 'present'
+  | 'collect_independent_inputs'
+  | 'round_robin'
+  | 'compare'
+  | 'decide'
+  | 'summarize'
+  | 'emit_tasks'
+  | 'wait'
+  | 'dispatch_task'
+  | 'dispatch_delegation'
+
+export interface ProtocolPhaseDefinition {
+  id: string
+  kind: ProtocolPhaseKind
+  label: string
+  instructions?: string | null
+  turnLimit?: number | null
+  completionCriteria?: string | null
+  taskConfig?: { agentId?: string; title: string; description: string } | null
+  delegationConfig?: { agentId: string; message: string } | null
+}
+
+export type ProtocolConditionDefinition =
+  | { type: 'summary_exists' }
+  | { type: 'artifact_exists'; artifactKind?: ProtocolRunArtifact['kind'] | null }
+  | { type: 'artifact_count_at_least'; count: number; artifactKind?: ProtocolRunArtifact['kind'] | null }
+  | { type: 'created_task_count_at_least'; count: number }
+  | { type: 'all'; conditions: ProtocolConditionDefinition[] }
+  | { type: 'any'; conditions: ProtocolConditionDefinition[] }
+
+export interface ProtocolBranchCase {
+  id: string
+  label: string
+  nextStepId: string
+  description?: string | null
+  when?: ProtocolConditionDefinition | null
+}
+
+export interface ProtocolRepeatConfig {
+  bodyStepId: string
+  nextStepId?: string | null
+  maxIterations: number
+  exitCondition?: ProtocolConditionDefinition | null
+  onExhausted?: 'advance' | 'fail'
+}
+
+export interface ProtocolParallelBranchDefinition {
+  id: string
+  label: string
+  steps: ProtocolStepDefinition[]
+  entryStepId?: string | null
+  participantAgentIds?: string[]
+  facilitatorAgentId?: string | null
+  observerAgentIds?: string[]
+}
+
+export interface ProtocolParallelConfig {
+  branches: ProtocolParallelBranchDefinition[]
+}
+
+export interface ProtocolJoinConfig {
+  parallelStepId?: string | null
+}
+
+export type ProtocolStepKind =
+  | ProtocolPhaseKind
+  | 'branch'
+  | 'repeat'
+  | 'parallel'
+  | 'join'
+  | 'complete'
+  | 'for_each'
+  | 'subflow'
+  | 'swarm_claim'
+
+export interface ProtocolStepDefinition {
+  id: string
+  kind: ProtocolStepKind
+  label: string
+  instructions?: string | null
+  turnLimit?: number | null
+  completionCriteria?: string | null
+  taskConfig?: { agentId?: string; title: string; description: string } | null
+  delegationConfig?: { agentId: string; message: string } | null
+  nextStepId?: string | null
+  branchCases?: ProtocolBranchCase[]
+  defaultNextStepId?: string | null
+  repeat?: ProtocolRepeatConfig | null
+  parallel?: ProtocolParallelConfig | null
+  join?: ProtocolJoinConfig | null
+  dependsOnStepIds?: string[]
+  outputKey?: string | null
+  forEach?: ProtocolForEachConfig | null
+  subflow?: ProtocolSubflowConfig | null
+  swarm?: ProtocolSwarmConfig | null
+}
+
+export interface ProtocolTemplate {
+  id: string
+  name: string
+  description: string
+  builtIn: boolean
+  singleAgentAllowed?: boolean
+  tags?: string[]
+  recommendedOutputs?: string[]
+  defaultPhases: ProtocolPhaseDefinition[]
+  steps?: ProtocolStepDefinition[]
+  entryStepId?: string | null
+  createdAt?: number
+  updatedAt?: number
+}
+
+export type ProtocolSourceRef =
+  | { kind: 'manual' }
+  | { kind: 'api' }
+  | { kind: 'session'; sessionId: string }
+  | { kind: 'chatroom'; chatroomId: string }
+  | { kind: 'mission'; missionId: string }
+  | { kind: 'task'; taskId: string }
+  | { kind: 'schedule'; scheduleId: string }
+  | { kind: 'protocol_run'; runId: string; parentRunId?: string | null; stepId?: string | null; branchId?: string | null }
+
+export interface ProtocolRunArtifact {
+  id: string
+  kind: 'summary' | 'decision' | 'comparison' | 'notes' | 'action_items'
+  title: string
+  content: string
+  phaseId?: string | null
+  taskIds?: string[]
+  createdAt: number
+}
+
+export interface ProtocolRunPhaseStateResponse {
+  agentId: string
+  text: string
+  toolEvents?: MessageToolEvent[]
+}
+
+export interface ProtocolRunPhaseState {
+  phaseId: string
+  respondedAgentIds?: string[]
+  responses?: ProtocolRunPhaseStateResponse[]
+  appendedToTranscript?: boolean
+  artifactId?: string | null
+  dispatchedTaskId?: string | null
+}
+
+export interface ProtocolRunLoopState {
+  stepId: string
+  iterationCount: number
+}
+
+export interface ProtocolRunBranchDecision {
+  stepId: string
+  caseId?: string | null
+  nextStepId?: string | null
+  decidedAt: number
+}
+
+export interface ProtocolRunParallelBranchState {
+  branchId: string
+  label: string
+  runId: string
+  status: ProtocolRunStatus
+  participantAgentIds?: string[]
+  summary?: string | null
+  lastError?: string | null
+  updatedAt: number
+}
+
+export interface ProtocolRunParallelStepState {
+  stepId: string
+  branchRunIds: string[]
+  branches: ProtocolRunParallelBranchState[]
+  waitingOnBranchIds?: string[]
+  joinReady?: boolean
+  joinCompletedAt?: number | null
+}
+
+// --- DAG Step State ---
+
+export type ProtocolRunStepStatus = 'pending' | 'ready' | 'running' | 'waiting' | 'completed' | 'failed' | 'skipped'
+
+export interface ProtocolRunStepState {
+  stepId: string
+  status: ProtocolRunStepStatus
+  startedAt?: number | null
+  completedAt?: number | null
+  error?: string | null
+}
+
+export interface ProtocolRunStepOutput {
+  stepId: string
+  outputKey?: string | null
+  summary?: string | null
+  artifactIds?: string[]
+  taskIds?: string[]
+  childRunIds?: string[]
+  structuredData?: Record<string, unknown> | null
+}
+
+// --- For-Each Config ---
+
+export interface ProtocolForEachConfig {
+  itemsSource:
+    | { type: 'literal'; items: unknown[] }
+    | { type: 'step_output'; stepId: string; path?: string | null }
+    | { type: 'artifact'; artifactId?: string | null; artifactKind?: string | null }
+    | { type: 'llm_extract'; prompt: string }
+  itemAlias: string
+  branchTemplate: {
+    steps: ProtocolStepDefinition[]
+    entryStepId?: string | null
+    participantAgentIds?: string[]
+    facilitatorAgentId?: string | null
+  }
+  joinMode: 'all'
+  maxItems?: number | null
+  onEmpty?: 'fail' | 'skip' | 'advance'
+}
+
+export interface ProtocolRunForEachStepState {
+  stepId: string
+  items: unknown[]
+  branchRunIds: string[]
+  branches: ProtocolRunParallelBranchState[]
+  waitingOnBranchIds?: string[]
+  joinReady?: boolean
+  joinCompletedAt?: number | null
+}
+
+// --- Subflow Config ---
+
+export interface ProtocolSubflowConfig {
+  templateId: string
+  templateVersion?: string | null
+  participantAgentIds?: string[]
+  facilitatorAgentId?: string | null
+  inputMapping?: Record<string, string> | null
+  outputMapping?: Record<string, string> | null
+  onFailure: 'fail_parent' | 'advance_with_warning'
+}
+
+export interface ProtocolRunSubflowState {
+  stepId: string
+  childRunId: string
+  templateId: string
+  status: ProtocolRunStatus
+  summary?: string | null
+  lastError?: string | null
+  startedAt?: number | null
+  completedAt?: number | null
+}
+
+// --- Swarm Config ---
+
+export interface ProtocolSwarmConfig {
+  eligibleAgentIds: string[]
+  workItemsSource:
+    | { type: 'literal'; items: Array<{ id: string; label: string; description?: string | null }> }
+    | { type: 'step_output'; stepId: string; path?: string | null }
+  claimLimitPerAgent?: number | null
+  selectionMode: 'first_claim' | 'claim_until_empty'
+  claimTimeoutSec: number
+  onUnclaimed: 'fail' | 'advance' | 'fallback_assign'
+}
+
+export interface ProtocolSwarmClaim {
+  id: string
+  workItemId: string
+  workItemLabel: string
+  agentId: string
+  childRunId?: string | null
+  taskId?: string | null
+  status: 'claimed' | 'running' | 'completed' | 'failed'
+  claimedAt: number
+  completedAt?: number | null
+}
+
+export interface ProtocolRunSwarmState {
+  stepId: string
+  workItems: Array<{ id: string; label: string; description?: string | null }>
+  claims: ProtocolSwarmClaim[]
+  unclaimedItemIds: string[]
+  eligibleAgentIds: string[]
+  claimLimitPerAgent: number
+  selectionMode: 'first_claim' | 'claim_until_empty'
+  claimTimeoutSec: number
+  openedAt: number
+  closedAt?: number | null
+  timedOut?: boolean
+}
+
+export interface ProtocolRunConfig {
+  goal?: string | null
+  kickoffMessage?: string | null
+  roundLimit?: number | null
+  decisionMode?: string | null
+  createTranscript?: boolean
+  autoEmitTasks?: boolean
+  taskProjectId?: string | null
+  postSummaryToParent?: boolean
+}
+
+export interface ProtocolRun {
+  id: string
+  title: string
+  templateId: string
+  templateName: string
+  status: ProtocolRunStatus
+  sourceRef: ProtocolSourceRef
+  participantAgentIds: string[]
+  facilitatorAgentId?: string | null
+  observerAgentIds?: string[]
+  missionId?: string | null
+  taskId?: string | null
+  sessionId?: string | null
+  parentRunId?: string | null
+  parentStepId?: string | null
+  branchId?: string | null
+  parentChatroomId?: string | null
+  transcriptChatroomId?: string | null
+  scheduleId?: string | null
+  systemOwned?: boolean
+  phases: ProtocolPhaseDefinition[]
+  steps?: ProtocolStepDefinition[]
+  entryStepId?: string | null
+  currentStepId?: string | null
+  config?: ProtocolRunConfig | null
+  currentPhaseIndex: number
+  roundNumber?: number
+  summary?: string | null
+  latestArtifactId?: string | null
+  artifacts?: ProtocolRunArtifact[]
+  createdTaskIds?: string[]
+  waitingReason?: string | null
+  pauseReason?: string | null
+  lastError?: string | null
+  operatorContext?: string[]
+  phaseState?: ProtocolRunPhaseState | null
+  loopState?: Record<string, ProtocolRunLoopState>
+  branchHistory?: ProtocolRunBranchDecision[]
+  parallelState?: Record<string, ProtocolRunParallelStepState>
+  stepState?: Record<string, ProtocolRunStepState>
+  completedStepIds?: string[]
+  runningStepIds?: string[]
+  readyStepIds?: string[]
+  failedStepIds?: string[]
+  stepOutputs?: Record<string, ProtocolRunStepOutput>
+  forEachState?: Record<string, ProtocolRunForEachStepState>
+  subflowState?: Record<string, ProtocolRunSubflowState>
+  swarmState?: Record<string, ProtocolRunSwarmState>
+  createdAt: number
+  updatedAt: number
+  startedAt?: number | null
+  endedAt?: number | null
+  archivedAt?: number | null
+}
+
+export interface ProtocolRunEvent {
+  id: string
+  runId: string
+  type:
+    | 'created'
+    | 'phase_started'
+    | 'phase_completed'
+    | 'participant_response'
+    | 'artifact_emitted'
+    | 'task_emitted'
+    | 'waiting'
+    | 'paused'
+    | 'resumed'
+    | 'phase_skipped'
+    | 'phase_retried'
+    | 'context_injected'
+    | 'recovered'
+    | 'step_started'
+    | 'step_completed'
+    | 'branch_taken'
+    | 'parallel_started'
+    | 'parallel_branch_spawned'
+    | 'parallel_branch_completed'
+    | 'parallel_branch_failed'
+    | 'join_ready'
+    | 'join_completed'
+    | 'loop_iteration_started'
+    | 'loop_iteration_completed'
+    | 'loop_exhausted'
+    | 'completed'
+    | 'failed'
+    | 'warning'
+    | 'cancelled'
+    | 'task_dispatched'
+    | 'delegation_dispatched'
+    | 'archived'
+    | 'summary_posted'
+    | 'step_ready'
+    | 'step_waiting'
+    | 'step_failed'
+    | 'for_each_expanded'
+    | 'subflow_started'
+    | 'subflow_completed'
+    | 'subflow_failed'
+    | 'swarm_opened'
+    | 'swarm_claimed'
+    | 'swarm_exhausted'
+  summary: string
+  phaseId?: string | null
+  stepId?: string | null
+  agentId?: string | null
+  artifactId?: string | null
+  taskId?: string | null
+  createdAt: number
+  data?: Record<string, unknown> | null
+}

package/src/types/provider.ts

@@ -0,0 +1,52 @@
+export type ProviderType = 'claude-cli' | 'codex-cli' | 'opencode-cli' | 'gemini-cli' | 'openai' | 'ollama' | 'anthropic' | 'openclaw' | 'google' | 'deepseek' | 'groq' | 'together' | 'mistral' | 'xai' | 'fireworks' | 'nebius' | 'deepinfra'
+export type ProviderId = ProviderType | (string & {})
+
+export interface ProviderInfo {
+  id: ProviderId
+  name: string
+  models: string[]
+  defaultModels?: string[]
+  supportsModelDiscovery?: boolean
+  requiresApiKey: boolean
+  optionalApiKey?: boolean
+  requiresEndpoint: boolean
+  defaultEndpoint?: string
+}
+
+export interface ProviderModelDiscoveryResult {
+  ok: boolean
+  providerId: string
+  providerName?: string
+  models: string[]
+  cached: boolean
+  fetchedAt: number
+  cacheTtlMs: number
+  supportsDiscovery: boolean
+  missingCredential?: boolean
+  message?: string
+}
+
+export interface Credential {
+  id: string
+  provider: string
+  name: string
+  createdAt: number
+}
+
+export type Credentials = Record<string, Credential>
+export type OllamaMode = 'local' | 'cloud'
+
+// --- Custom Providers ---
+
+export interface ProviderConfig {
+  id: string
+  name: string
+  type: 'builtin' | 'custom'
+  baseUrl?: string
+  models: string[]
+  requiresApiKey: boolean
+  credentialId?: string | null
+  isEnabled: boolean
+  createdAt: number
+  updatedAt: number
+}