@vepler/schools-types/api/validation.d.ts

TypeScript type definitions for Vepler Schools Service

/**
 * API Validation Types
 *
 * Validation related types that API consumers might need.
 * This file contains only validation-related constants and types
 * that are relevant to API consumers, not implementation details.
 */
/**
 * Common validation constraints for API parameters
 */
export declare const ValidationLimits: {
    /** Pagination limits */
    PAGINATION: {
        /** Maximum results per page */
        MAX_LIMIT: number;
        /** Default results per page */
        DEFAULT_LIMIT: number;
    };
    /** Geographic limits */
    GEOGRAPHIC: {
        /** Maximum search radius in kilometers */
        MAX_RADIUS_KM: number;
        /** Minimum search radius in kilometers */
        MIN_RADIUS_KM: number;
    };
    /** Search limits */
    SEARCH: {
        /** Maximum number of search results */
        MAX_RESULTS: number;
        /** Maximum number of autocomplete suggestions */
        MAX_SUGGESTIONS: number;
    };
};
/**
 * Valid school status values
 */
export type SchoolStatus = 'open' | 'closed' | 'pending_closure';
/**
 * Valid school type values
 */
export type SchoolType = 'nursery' | 'primary' | 'secondary' | 'all-through' | 'sixth-form' | 'special' | 'independent' | 'academy' | 'other';
/**
 * Valid Ofsted rating values
 */
export type OfstedRating = 'outstanding' | 'good' | 'requires_improvement' | 'inadequate';