pipeline-sdk 0.1.0

package/src/types.ts

@@ -0,0 +1,210 @@
+// ─── Pipeline Definition (YAML → parsed) ─────────────────
+
+export interface PipelineDefinition {
+	id: string;
+	version: number;
+	description?: string;
+	initial: string;
+	execution?: ExecutionConfig;
+	stages: Record<string, StageDefinition>;
+	gates?: Record<string, GateDefinition>;
+	conditions?: Record<string, ConditionDefinition>;
+}
+
+export interface ExecutionConfig {
+	provider?: string;
+	mode?: "daemon" | "binary";
+	timeout?: string;
+	evidence_dir?: string;
+	webhook_port?: number;
+	webhook_secret?: string;
+}
+
+export interface StageDefinition {
+	description?: string;
+	type?: "terminal" | "parallel-child";
+	agent?: AgentConfig;
+	gates?: { entry?: string[]; exit?: string[] };
+	on?: Record<string, TransitionDefinition>;
+	parallel?: string[];
+	when?: string;
+	max_retries?: number;
+	cleanup?: CleanupHandler[];
+	on_enter?: OnEnterAction[];
+	trigger?: TriggerConfig;
+}
+
+export interface AgentConfig {
+	instructions?: string;
+	tools?: string[];
+	model?: string;
+	mode?: string;
+}
+
+export interface TransitionDefinition {
+	target: string;
+	guard?: string;
+}
+
+export interface GateDefinition {
+	type: "builtin" | "custom" | "async";
+	command?: string;
+	script?: string;
+	protocol?: string;
+	signal?: string;
+	timeout?: string;
+	escalate_after?: string;
+	expect?: Record<string, unknown>;
+	inputs?: Record<string, unknown>;
+	when?: string;
+}
+
+export interface ConditionDefinition {
+	check: string;
+	pattern?: string;
+	path?: string;
+	not?: string;
+}
+
+export interface CleanupHandler {
+	script: string;
+	inputs?: Record<string, unknown>;
+}
+
+export interface OnEnterAction {
+	script: string;
+	inputs?: Record<string, unknown>;
+}
+
+export interface TriggerConfig {
+	type: "schedule";
+	cron: string;
+}
+
+// ─── Runtime State ────────────────────────────────────────
+
+export interface PipelineState {
+	pipeline_id: string;
+	current_stage: string;
+	started_at: string;
+	stages_completed: string[];
+	retry_count: Record<string, number>;
+	evidence_chain_head: string | null;
+	cleanup_pending?: string[];
+}
+
+// ─── Evidence ─────────────────────────────────────────────
+
+export interface EvidenceRecord {
+	stage_id: string;
+	pipeline_id: string;
+	timestamp: string;
+	duration_ms: number;
+	agent: { provider: string; model?: string; session_id?: string };
+	gates_passed: GateResult[];
+	artifacts: ArtifactRef[];
+	git: { tree_sha: string; branch?: string; files_changed?: number };
+	previous_evidence_hash: string | null;
+	evidence_hash: string;
+}
+
+export interface GateResult {
+	gate: string;
+	exit_code: number;
+	duration_ms: number;
+	evidence?: { type: string; hash: string };
+}
+
+export interface ArtifactRef {
+	type: string;
+	path: string;
+	hash: string;
+}
+
+// ─── Gate Protocol ────────────────────────────────────────
+
+export interface GateInput {
+	gate_id: string;
+	stage_id: string;
+	pipeline_id: string;
+	inputs: Record<string, unknown>;
+	evidence_chain: Array<{ stage: string; hash: string }>;
+	workspace: { root: string; packages?: string[] };
+	context: {
+		branch: string;
+		commit: string;
+		provider: string;
+		session_id?: string;
+	};
+}
+
+export interface GateVerdict {
+	status: "pass" | "fail" | "skip";
+	evidence?: {
+		type: string;
+		summary: string;
+		artifacts: ArtifactRef[];
+		details?: Record<string, unknown>;
+	};
+	message: string;
+	suggested_action?: string;
+}
+
+// ─── IPC Protocol ─────────────────────────────────────────
+
+export interface IpcRequest {
+	type: "tool_check" | "advance" | "signal" | "status";
+	tool?: string;
+	command?: string;
+	event?: string;
+	signal?: string;
+	evidence?: Record<string, unknown>;
+	stage?: string;
+	session_id?: string;
+	source?: string;
+}
+
+export interface IpcResponse {
+	verdict?: "allow" | "deny" | "transition";
+	allowed?: boolean;
+	reason?: string;
+	current_stage?: string;
+	allowed_tools?: string[];
+	blocked_commands?: string[];
+	transitioned?: boolean;
+	new_stage?: string;
+	received?: boolean;
+	gate_cleared?: string;
+	stage?: string;
+	gates_remaining?: string[];
+	elapsed?: string;
+	completed_stages?: string[];
+	allowed_events?: string[];
+	error?: string;
+}
+
+// ─── Provider Adapter ─────────────────────────────────────
+
+export interface ProviderCapabilities {
+	name: string;
+	hooks: boolean;
+	parallel: boolean;
+	session: boolean;
+	headless: boolean;
+	mcp: boolean;
+}
+
+export interface StageRequest {
+	stage_id: string;
+	instructions: string;
+	tools: string[];
+	context: Record<string, unknown>;
+	timeout?: number;
+}
+
+export interface StageOutput {
+	artifacts: ArtifactRef[];
+	stdout: string;
+	exit_code: number;
+	duration_ms: number;
+}