@davidtnfsh/etl-contracts

Shared TypeScript and Zod contracts for the All Weather ETL job status system.

Installation

npm install @davidtnfsh/etl-contracts

Usage

import { EtlJobStatusSchema, type EtlJobStatus } from '@davidtnfsh/etl-contracts';

// Validate API responses
const response = await fetch('/api/jobs/123');
const data = await response.json();
const validated = EtlJobStatusSchema.parse(data);

// TypeScript types
const job: EtlJobStatus = {
  jobId: 'etl_123',
  status: 'completed',
  trigger: 'webhook',
  createdAt: '2025-01-07T10:00:00Z',
  recordsProcessed: 100,
  recordsInserted: 95
};

Schemas

• EtlJobStatusSchema - Job status response (flat structure)
• EtlJobCreatedSchema - Job creation response
• EtlErrorSchema - Error structure
• JobStatusEnum - Status values: pending, processing, completed, failed
• ErrorCodeEnum - Error codes: API_ERROR, VALIDATION_ERROR, INTERNAL_ERROR, RATE_LIMIT_EXCEEDED

Types

All types are inferred from Zod schemas:

• EtlJobStatus
• EtlJobCreated
• EtlError
• JobStatus
• ErrorCode

License

ISC