@venulog/phasing-engine-schemas

Shared schemas and types for Phasing Engine API. Provides Zod validation schemas, TypeScript types, and OpenAPI documentation support.

Installation

This package is designed to be used as a local workspace package:

npm install @venulog/phasing-engine-schemas

Usage

import {
  phaseBookingSchema,
  PhaseBooking,
  BookingStatus,
  SlotStatus
} from '@venulog/phasing-engine-schemas';

// Use schemas for validation
const booking = phaseBookingSchema.parse(data);

// Use types for type safety
const createBooking = (booking: PhaseBooking) => {
  // ...
};

// Use enums for status values
if (booking.status === BookingStatus.CONFIRMED) {
  // ...
}

Available Exports

Schemas

• auth - Authentication related schemas
• common - Base response schemas and factory functions
• pagination - Pagination and sorting schemas
• phaseBooking - Phase booking operation schemas
• phaseSlot - Phase slot management schemas

Enums

• BookingStatus - Booking status values
• SlotStatus - Slot status values

Types

All schemas export corresponding TypeScript types using Zod's z.infer<>.

Development

# Build the package
npm run build

# Watch mode for development
npm run dev

# Clean build artifacts
npm run clean