@snapback/contracts
v0.2.1
Published
Type definitions and contracts for SnapBack
Readme
@snapback/contracts
Shared type definitions and schemas for SnapBack.
Installation
npm install @snapback/contractsWhat's Included
- Type definitions for snapshots, files, risk assessments
- Zod schemas for runtime validation
- API contracts for request/response shapes
- Event types for the event bus
Quick Start
import type { Snapshot, RiskAssessment } from "@snapback/contracts";
import { SnapshotSchema } from "@snapback/contracts";
// Use types
const snap: Snapshot = { /* ... */ };
// Validate at runtime
const result = SnapshotSchema.safeParse(data);API Reference
See documentation for complete API reference and usage examples.
Development
pnpm build
pnpm test
pnpm generate-openapiLicense
MIT