@aida/sdd-core

TypeScript types for the SDD (Spec-Driven Development) Platform.

Installation

npm install @aida/sdd-core
# or
pnpm add @aida/sdd-core

Usage

import type {
  Spec,
  SpecType,
  SpecStatus,
  Process,
  Session,
  CreateSpecRequest,
  ApiResponse,
  ApiError,
} from "@aida/sdd-core";

// Create a spec
const request: CreateSpecRequest = {
  type: "FEA",
  title: "Implement user authentication",
  content: "# Feature: User Authentication\n...",
};

// Type-safe API responses
const response: ApiResponse<Spec> = await fetch("/api/specs", {
  method: "POST",
  body: JSON.stringify(request),
}).then((r) => r.json());

console.log(response.data.spec_number); // FEA-202601001

Available Types

Entity Types

• Spec - Core specification entity
• SpecType - Spec type prefix ('FEA' | 'ISS' | 'INV' | 'IMP' | 'EPC' | 'BKL')
• SpecStatus - Lifecycle status
• SpecWithScore - Spec with similarity score (from semantic search)
• Process - Reusable workflow/procedure
• ProcessStep - Individual step within a process
• Session - Work session on a spec
• SessionStatus - Session lifecycle status
• Workspace - Tenant/organization

API Request Types

• CreateSpecRequest
• UpdateSpecRequest
• ListSpecsQuery
• SearchSpecsRequest
• CreateProcessRequest
• UpdateProcessRequest
• CreateSessionRequest
• UpdateSessionRequest

API Response Types

• ApiResponse<T> - Standard response wrapper
• PaginatedResponse<T> - Paginated list response
• ApiError - Error response
• ValidationError - Validation error with field details
• ErrorCode - Standard error codes

Common Types

• UUID - UUID string type alias
• ISODateString - ISO 8601 date string
• BaseEntity - Common entity fields

Spec Types Explained

| Type | Description | Example | | ----- | ------------------------------ | --------------- | | FEA | Feature - New functionality | FEA-202601001 | | ISS | Issue - Bug fix | ISS-202601001 | | INV | Investigation - Research/spike | INV-202601001 | | IMP | Improvement - Enhancement | IMP-202601001 | | EPC | Epic - Large initiative | EPC-202601001 | | BKL | Backlog - Planned future work | BKL-202601001 |

Spec Status Lifecycle

draft → review → approved → in-progress → testing → completed
                    ↓           ↓
                cancelled    blocked

License

MIT