AI-SDLC
AI-SDLC
API Reference

API Reference

API Reference

Complete reference for the AI-SDLC packages.

Orchestrator (@ai-sdlc/orchestrator)

The orchestrator runtime — CLI, agent runners, codebase analysis, and state store.

ModuleDescription
RunnersAgent runners (Claude Code, Copilot, Cursor, Codex, GenericLLM) and runner registry

SDK (@ai-sdlc/reference)

The TypeScript reference implementation, structured as a single package with 12 modules:

@ai-sdlc/reference
├── core/         — Types, validation, provenance, comparison
├── builders/     — Fluent resource builders for all 5 resource types
├── policy/       — Enforcement, autonomy, authorization, admission
├── adapters/     — Interface contracts, built-in + stub adapters
├── agents/       — Orchestration patterns, execution, memory, discovery
├── reconciler/   — Controller loop, diff, resource reconcilers
├── audit/        — Hash-chained audit log with pluggable sinks
├── metrics/      — Metric store, standard metrics, instrumentation
├── telemetry/    — OpenTelemetry tracing, structured logging
├── security/     — Sandbox, JIT credentials, kill switch, approvals
└── compliance/   — Regulatory framework mapping and checking

Import Patterns

All exports are available from the root:

import { validate, enforce, PipelineBuilder } from '@ai-sdlc/reference';

Module Reference

ModulePackageDescriptionKey Exports
Runners@ai-sdlc/orchestratorAgent runners and registryClaudeCodeRunner, CopilotRunner, CursorRunner, CodexRunner, GenericLLMRunner, RunnerRegistry, createRunnerRegistry
Core@ai-sdlc/referenceTypes, validation, provenancevalidate, validateResource, createProvenance, API_VERSION
Builders@ai-sdlc/referenceFluent resource constructionPipelineBuilder, AgentRoleBuilder, QualityGateBuilder, AutonomyPolicyBuilder, AdapterBindingBuilder
Policy@ai-sdlc/referenceEnforcement and authorizationenforce, evaluatePromotion, authorize, admitResource, parseDuration
Adapters@ai-sdlc/referenceExternal tool integrationsIssueTracker, SourceControl, CIPipeline, createAdapterRegistry
Agents@ai-sdlc/referenceMulti-agent orchestrationsequential, parallel, executeOrchestration, validateHandoff
Reconciler@ai-sdlc/referenceController loop patternReconcilerLoop, reconcileOnce, resourceFingerprint
Audit@ai-sdlc/referenceTamper-evident audit loggingcreateAuditLog, createFileSink, computeEntryHash
Metrics@ai-sdlc/referenceMetric collection and queryingcreateMetricStore, STANDARD_METRICS
Telemetry@ai-sdlc/referenceOpenTelemetry + structured loggingwithSpan, createConsoleLogger, createBufferLogger
Security@ai-sdlc/referenceEnterprise security primitivesSandbox, KillSwitch, JITCredentialIssuer, ApprovalWorkflow
Compliance@ai-sdlc/referenceRegulatory framework coveragecheckCompliance, checkAllFrameworks, getAllControlIds

Resource Types

Five core resource types, all sharing the same envelope:

Common definitions (metadata, conditions, secretRef, duration) are in common.schema.json.

Quick Start

import {
  PipelineBuilder,
  QualityGateBuilder,
  enforce,
  validateResource,
} from '@ai-sdlc/reference';

// Build a pipeline
const pipeline = new PipelineBuilder('my-pipeline')
  .addTrigger({ event: 'issue.assigned' })
  .addProvider('issueTracker', { type: 'linear' })
  .addStage({ name: 'implement', agent: 'code-agent' })
  .build();

// Validate it
const result = validateResource(pipeline);
console.log(result.valid); // true

// Build and enforce a quality gate
const gate = new QualityGateBuilder('standards')
  .addGate({
    name: 'coverage',
    enforcement: 'soft-mandatory',
    rule: { metric: 'line-coverage', operator: '>=', threshold: 80 },
  })
  .build();

const enforcement = enforce(gate, {
  authorType: 'ai-agent',
  repository: 'org/repo',
  metrics: { 'line-coverage': 85 },
});
console.log(enforcement.allowed); // true

Adapter Interfaces

See adapters.md for the full normative interface contracts.