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

TypeScript type definitions for Vepler Schools Service

/**
 * Map API Types
 *
 * Types for the map tile API endpoints.
 */
/**
 * Map tile parameters interface
 */
export interface MapTileParams {
    /**
     * Layer identifier
     * @example "schools"
     * @example "local-authorities"
     */
    layerId: string;
    /**
     * Zoom level
     * @minimum 0
     * @maximum 22
     */
    z: number;
    /**
     * X coordinate
     * @minimum 0
     */
    x: number;
    /**
     * Y coordinate
     * @minimum 0
     */
    y: number;
}
/**
 * Map layer metadata
 */
export interface MapLayerMetadata {
    /**
     * Layer identifier
     */
    id: string;
    /**
     * Human-readable layer name
     */
    name: string;
    /**
     * Layer description
     */
    description: string;
    /**
     * Minimum zoom level where layer is visible
     */
    minZoom: number;
    /**
     * Maximum zoom level where layer is visible
     */
    maxZoom: number;
    /**
     * Attribution text
     */
    attribution: string;
    /**
     * Default layer style
     */
    defaultStyle?: string;
    /**
     * Available style options
     */
    styles?: string[];
}