iracing-api/lib/types/common.d.ts

Javascript client for iracing API

import * as z from 'zod';
export declare const CategorySchema: z.ZodEnum<["dirt_oval", "dirt_road", "formula_car", "oval", "sports_car"]>;
export type CarCategory = z.infer<typeof CategorySchema>;
export declare const CarTypeSchema: z.ZodObject<{
    carType: z.ZodString;
}, "strip", z.ZodTypeAny, {
    carType: string;
}, {
    carType: string;
}>;
export type CarType = z.infer<typeof CarTypeSchema>;
export declare const EligSchema: z.ZodObject<{
    sessionFull: z.ZodBoolean;
    canSpot: z.ZodBoolean;
    canWatch: z.ZodBoolean;
    canDrive: z.ZodBoolean;
    hasSessPassword: z.ZodBoolean;
    needsPurchase: z.ZodBoolean;
    ownCar: z.ZodBoolean;
    ownTrack: z.ZodBoolean;
    purchaseSkus: z.ZodArray<z.ZodNumber, "many">;
    registered: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
    sessionFull: boolean;
    canSpot: boolean;
    canWatch: boolean;
    canDrive: boolean;
    hasSessPassword: boolean;
    needsPurchase: boolean;
    ownCar: boolean;
    ownTrack: boolean;
    purchaseSkus: number[];
    registered: boolean;
}, {
    sessionFull: boolean;
    canSpot: boolean;
    canWatch: boolean;
    canDrive: boolean;
    hasSessPassword: boolean;
    needsPurchase: boolean;
    ownCar: boolean;
    ownTrack: boolean;
    purchaseSkus: number[];
    registered: boolean;
}>;
export type Elig = z.infer<typeof EligSchema>;
export declare const EventTypeSchema: z.ZodObject<{
    eventType: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    eventType: number;
}, {
    eventType: number;
}>;
export type EventType = z.infer<typeof EventTypeSchema>;
export declare const FarmSchema: z.ZodObject<{
    farmId: z.ZodNumber;
    displayName: z.ZodString;
    imagePath: z.ZodString;
    displayed: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
    farmId: number;
    displayName: string;
    imagePath: string;
    displayed: boolean;
}, {
    farmId: number;
    displayName: string;
    imagePath: string;
    displayed: boolean;
}>;
export type Farm = z.infer<typeof FarmSchema>;
export declare const HelmetSchema: z.ZodObject<{
    pattern: z.ZodNumber;
    color1: z.ZodString;
    color2: z.ZodString;
    color3: z.ZodString;
    faceType: z.ZodNumber;
    helmetType: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    pattern: number;
    color1: string;
    color2: string;
    color3: string;
    faceType: number;
    helmetType: number;
}, {
    pattern: number;
    color1: string;
    color2: string;
    color3: string;
    faceType: number;
    helmetType: number;
}>;
export type Helmet = z.infer<typeof HelmetSchema>;
export declare const HostSchema: z.ZodObject<{
    custId: z.ZodNumber;
    displayName: z.ZodString;
    helmet: z.ZodObject<{
        pattern: z.ZodNumber;
        color1: z.ZodString;
        color2: z.ZodString;
        color3: z.ZodString;
        faceType: z.ZodNumber;
        helmetType: z.ZodNumber;
    }, "strip", z.ZodTypeAny, {
        pattern: number;
        color1: string;
        color2: string;
        color3: string;
        faceType: number;
        helmetType: number;
    }, {
        pattern: number;
        color1: string;
        color2: string;
        color3: string;
        faceType: number;
        helmetType: number;
    }>;
}, "strip", z.ZodTypeAny, {
    displayName: string;
    custId: number;
    helmet: {
        pattern: number;
        color1: string;
        color2: string;
        color3: string;
        faceType: number;
        helmetType: number;
    };
}, {
    displayName: string;
    custId: number;
    helmet: {
        pattern: number;
        color1: string;
        color2: string;
        color3: string;
        faceType: number;
        helmetType: number;
    };
}>;
export type Host = z.infer<typeof HostSchema>;
export declare const LicenseGroupTypeSchema: z.ZodObject<{
    licenseGroupType: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    licenseGroupType: number;
}, {
    licenseGroupType: number;
}>;
export type LicenseGroupType = z.infer<typeof LicenseGroupTypeSchema>;
export declare const SessionTypeSchema: z.ZodObject<{
    sessionType: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    sessionType: number;
}, {
    sessionType: number;
}>;
export type SessionType = z.infer<typeof SessionTypeSchema>;
export declare const TrackStateSchema: z.ZodObject<{
    leaveMarbles: z.ZodBoolean;
    practiceGripCompound: z.ZodNumber;
    practiceRubber: z.ZodNumber;
    qualifyGripCompound: z.ZodNumber;
    qualifyRubber: z.ZodNumber;
    raceGripCompound: z.ZodNumber;
    raceRubber: z.ZodNumber;
    warmupGripCompound: z.ZodNumber;
    warmupRubber: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    leaveMarbles: boolean;
    practiceGripCompound: number;
    practiceRubber: number;
    qualifyGripCompound: number;
    qualifyRubber: number;
    raceGripCompound: number;
    raceRubber: number;
    warmupGripCompound: number;
    warmupRubber: number;
}, {
    leaveMarbles: boolean;
    practiceGripCompound: number;
    practiceRubber: number;
    qualifyGripCompound: number;
    qualifyRubber: number;
    raceGripCompound: number;
    raceRubber: number;
    warmupGripCompound: number;
    warmupRubber: number;
}>;
export type TrackState = z.infer<typeof TrackStateSchema>;
export declare const ForecastOptionsSchema: z.ZodObject<{
    forecastType: z.ZodNumber;
    precipitation: z.ZodNumber;
    skies: z.ZodNumber;
    stopPrecip: z.ZodNumber;
    temperature: z.ZodNumber;
    windDir: z.ZodNumber;
    windSpeed: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    forecastType: number;
    precipitation: number;
    skies: number;
    stopPrecip: number;
    temperature: number;
    windDir: number;
    windSpeed: number;
}, {
    forecastType: number;
    precipitation: number;
    skies: number;
    stopPrecip: number;
    temperature: number;
    windDir: number;
    windSpeed: number;
}>;
export type ForecastOptions = z.infer<typeof ForecastOptionsSchema>;
export declare const MaxPrecipRateDescSchema: z.ZodEnum<["Heavy", "Light", "Moderate", "None"]>;
export type MaxPrecipRateDesc = z.infer<typeof MaxPrecipRateDescSchema>;
export declare const WeatherSummarySchema: z.ZodObject<{
    maxPrecipRate: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    maxPrecipRateDesc: z.ZodEnum<["Heavy", "Light", "Moderate", "None"]>;
    precipChance: z.ZodNumber;
    skiesHigh: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    skiesLow: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    tempHigh: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    tempLow: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    tempUnits: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    windHigh: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    windLow: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    windUnits: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
}, "strip", z.ZodTypeAny, {
    maxPrecipRateDesc: "Heavy" | "Light" | "Moderate" | "None";
    precipChance: number;
    maxPrecipRate?: number | null | undefined;
    skiesHigh?: number | null | undefined;
    skiesLow?: number | null | undefined;
    tempHigh?: number | null | undefined;
    tempLow?: number | null | undefined;
    tempUnits?: number | null | undefined;
    windHigh?: number | null | undefined;
    windLow?: number | null | undefined;
    windUnits?: number | null | undefined;
}, {
    maxPrecipRateDesc: "Heavy" | "Light" | "Moderate" | "None";
    precipChance: number;
    maxPrecipRate?: number | null | undefined;
    skiesHigh?: number | null | undefined;
    skiesLow?: number | null | undefined;
    tempHigh?: number | null | undefined;
    tempLow?: number | null | undefined;
    tempUnits?: number | null | undefined;
    windHigh?: number | null | undefined;
    windLow?: number | null | undefined;
    windUnits?: number | null | undefined;
}>;
export type WeatherSummary = z.infer<typeof WeatherSummarySchema>;
export declare const WeatherSchema: z.ZodObject<{
    allowFog: z.ZodBoolean;
    fog: z.ZodNumber;
    forecastOptions: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
        forecastType: z.ZodNumber;
        precipitation: z.ZodNumber;
        skies: z.ZodNumber;
        stopPrecip: z.ZodNumber;
        temperature: z.ZodNumber;
        windDir: z.ZodNumber;
        windSpeed: z.ZodNumber;
    }, "strip", z.ZodTypeAny, {
        forecastType: number;
        precipitation: number;
        skies: number;
        stopPrecip: number;
        temperature: number;
        windDir: number;
        windSpeed: number;
    }, {
        forecastType: number;
        precipitation: number;
        skies: number;
        stopPrecip: number;
        temperature: number;
        windDir: number;
        windSpeed: number;
    }>, z.ZodNull]>>;
    humidityUnits: z.ZodNumber;
    precipOption: z.ZodNumber;
    relHumidity: z.ZodNumber;
    simulatedStartTime: z.ZodString;
    simulatedStartUtcTime: z.ZodString;
    simulatedTimeMultiplier: z.ZodNumber;
    simulatedTimeOffsets: z.ZodArray<z.ZodNumber, "many">;
    skies: z.ZodNumber;
    tempUnits: z.ZodNumber;
    tempValue: z.ZodNumber;
    timeOfDay: z.ZodNumber;
    trackWater: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    type: z.ZodNumber;
    version: z.ZodNumber;
    weatherSummary: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
        maxPrecipRate: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        maxPrecipRateDesc: z.ZodEnum<["Heavy", "Light", "Moderate", "None"]>;
        precipChance: z.ZodNumber;
        skiesHigh: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        skiesLow: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        tempHigh: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        tempLow: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        tempUnits: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        windHigh: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        windLow: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
        windUnits: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodNull]>>;
    }, "strip", z.ZodTypeAny, {
        maxPrecipRateDesc: "Heavy" | "Light" | "Moderate" | "None";
        precipChance: number;
        maxPrecipRate?: number | null | undefined;
        skiesHigh?: number | null | undefined;
        skiesLow?: number | null | undefined;
        tempHigh?: number | null | undefined;
        tempLow?: number | null | undefined;
        tempUnits?: number | null | undefined;
        windHigh?: number | null | undefined;
        windLow?: number | null | undefined;
        windUnits?: number | null | undefined;
    }, {
        maxPrecipRateDesc: "Heavy" | "Light" | "Moderate" | "None";
        precipChance: number;
        maxPrecipRate?: number | null | undefined;
        skiesHigh?: number | null | undefined;
        skiesLow?: number | null | undefined;
        tempHigh?: number | null | undefined;
        tempLow?: number | null | undefined;
        tempUnits?: number | null | undefined;
        windHigh?: number | null | undefined;
        windLow?: number | null | undefined;
        windUnits?: number | null | undefined;
    }>, z.ZodNull]>>;
    weatherUrl: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
    weatherVarInitial: z.ZodNumber;
    weatherVarOngoing: z.ZodNumber;
    windDir: z.ZodNumber;
    windUnits: z.ZodNumber;
    windValue: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    type: number;
    skies: number;
    windDir: number;
    tempUnits: number;
    windUnits: number;
    allowFog: boolean;
    fog: number;
    humidityUnits: number;
    precipOption: number;
    relHumidity: number;
    simulatedStartTime: string;
    simulatedStartUtcTime: string;
    simulatedTimeMultiplier: number;
    simulatedTimeOffsets: number[];
    tempValue: number;
    timeOfDay: number;
    version: number;
    weatherVarInitial: number;
    weatherVarOngoing: number;
    windValue: number;
    forecastOptions?: {
        forecastType: number;
        precipitation: number;
        skies: number;
        stopPrecip: number;
        temperature: number;
        windDir: number;
        windSpeed: number;
    } | null | undefined;
    trackWater?: number | null | undefined;
    weatherSummary?: {
        maxPrecipRateDesc: "Heavy" | "Light" | "Moderate" | "None";
        precipChance: number;
        maxPrecipRate?: number | null | undefined;
        skiesHigh?: number | null | undefined;
        skiesLow?: number | null | undefined;
        tempHigh?: number | null | undefined;
        tempLow?: number | null | undefined;
        tempUnits?: number | null | undefined;
        windHigh?: number | null | undefined;
        windLow?: number | null | undefined;
        windUnits?: number | null | undefined;
    } | null | undefined;
    weatherUrl?: string | null | undefined;
}, {
    type: number;
    skies: number;
    windDir: number;
    tempUnits: number;
    windUnits: number;
    allowFog: boolean;
    fog: number;
    humidityUnits: number;
    precipOption: number;
    relHumidity: number;
    simulatedStartTime: string;
    simulatedStartUtcTime: string;
    simulatedTimeMultiplier: number;
    simulatedTimeOffsets: number[];
    tempValue: number;
    timeOfDay: number;
    version: number;
    weatherVarInitial: number;
    weatherVarOngoing: number;
    windValue: number;
    forecastOptions?: {
        forecastType: number;
        precipitation: number;
        skies: number;
        stopPrecip: number;
        temperature: number;
        windDir: number;
        windSpeed: number;
    } | null | undefined;
    trackWater?: number | null | undefined;
    weatherSummary?: {
        maxPrecipRateDesc: "Heavy" | "Light" | "Moderate" | "None";
        precipChance: number;
        maxPrecipRate?: number | null | undefined;
        skiesHigh?: number | null | undefined;
        skiesLow?: number | null | undefined;
        tempHigh?: number | null | undefined;
        tempLow?: number | null | undefined;
        tempUnits?: number | null | undefined;
        windHigh?: number | null | undefined;
        windLow?: number | null | undefined;
        windUnits?: number | null | undefined;
    } | null | undefined;
    weatherUrl?: string | null | undefined;
}>;
export type Weather = z.infer<typeof WeatherSchema>;
export declare const HeatSesInfoSchema: z.ZodObject<{
    consolationDeltaMaxFieldSize: z.ZodNumber;
    consolationDeltaSessionLaps: z.ZodNumber;
    consolationDeltaSessionLengthMinutes: z.ZodNumber;
    consolationFirstMaxFieldSize: z.ZodNumber;
    consolationFirstSessionLaps: z.ZodNumber;
    consolationFirstSessionLengthMinutes: z.ZodNumber;
    consolationNumPositionToInvert: z.ZodNumber;
    consolationNumToConsolation: z.ZodNumber;
    consolationNumToMain: z.ZodNumber;
    consolationRunAlways: z.ZodBoolean;
    consolationScoresChampPoints: z.ZodBoolean;
    created: z.ZodString;
    custId: z.ZodNumber;
    heatCautionType: z.ZodNumber;
    heatInfoId: z.ZodNumber;
    heatInfoName: z.ZodString;
    heatLaps: z.ZodNumber;
    heatLengthMinutes: z.ZodNumber;
    heatMaxFieldSize: z.ZodNumber;
    heatNumFromEachToMain: z.ZodNumber;
    heatNumPositionToInvert: z.ZodNumber;
    heatScoresChampPoints: z.ZodBoolean;
    heatSessionMinutesEstimate: z.ZodNumber;
    hidden: z.ZodBoolean;
    mainLaps: z.ZodNumber;
    mainLengthMinutes: z.ZodNumber;
    mainMaxFieldSize: z.ZodNumber;
    mainNumPositionToInvert: z.ZodNumber;
    maxEntrants: z.ZodNumber;
    openPractice: z.ZodBoolean;
    preMainPracticeLengthMinutes: z.ZodNumber;
    preQualNumToMain: z.ZodNumber;
    preQualPracticeLengthMinutes: z.ZodNumber;
    qualCautionType: z.ZodNumber;
    qualLaps: z.ZodNumber;
    qualLengthMinutes: z.ZodNumber;
    qualNumToMain: z.ZodNumber;
    qualOpenDelaySeconds: z.ZodNumber;
    qualScoresChampPoints: z.ZodBoolean;
    qualScoring: z.ZodNumber;
    qualStyle: z.ZodNumber;
    raceStyle: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
    hidden: boolean;
    custId: number;
    consolationDeltaMaxFieldSize: number;
    consolationDeltaSessionLaps: number;
    consolationDeltaSessionLengthMinutes: number;
    consolationFirstMaxFieldSize: number;
    consolationFirstSessionLaps: number;
    consolationFirstSessionLengthMinutes: number;
    consolationNumPositionToInvert: number;
    consolationNumToConsolation: number;
    consolationNumToMain: number;
    consolationRunAlways: boolean;
    consolationScoresChampPoints: boolean;
    created: string;
    heatCautionType: number;
    heatInfoId: number;
    heatInfoName: string;
    heatLaps: number;
    heatLengthMinutes: number;
    heatMaxFieldSize: number;
    heatNumFromEachToMain: number;
    heatNumPositionToInvert: number;
    heatScoresChampPoints: boolean;
    heatSessionMinutesEstimate: number;
    mainLaps: number;
    mainLengthMinutes: number;
    mainMaxFieldSize: number;
    mainNumPositionToInvert: number;
    maxEntrants: number;
    openPractice: boolean;
    preMainPracticeLengthMinutes: number;
    preQualNumToMain: number;
    preQualPracticeLengthMinutes: number;
    qualCautionType: number;
    qualLaps: number;
    qualLengthMinutes: number;
    qualNumToMain: number;
    qualOpenDelaySeconds: number;
    qualScoresChampPoints: boolean;
    qualScoring: number;
    qualStyle: number;
    raceStyle: number;
}, {
    hidden: boolean;
    custId: number;
    consolationDeltaMaxFieldSize: number;
    consolationDeltaSessionLaps: number;
    consolationDeltaSessionLengthMinutes: number;
    consolationFirstMaxFieldSize: number;
    consolationFirstSessionLaps: number;
    consolationFirstSessionLengthMinutes: number;
    consolationNumPositionToInvert: number;
    consolationNumToConsolation: number;
    consolationNumToMain: number;
    consolationRunAlways: boolean;
    consolationScoresChampPoints: boolean;
    created: string;
    heatCautionType: number;
    heatInfoId: number;
    heatInfoName: string;
    heatLaps: number;
    heatLengthMinutes: number;
    heatMaxFieldSize: number;
    heatNumFromEachToMain: number;
    heatNumPositionToInvert: number;
    heatScoresChampPoints: boolean;
    heatSessionMinutesEstimate: number;
    mainLaps: number;
    mainLengthMinutes: number;
    mainMaxFieldSize: number;
    mainNumPositionToInvert: number;
    maxEntrants: number;
    openPractice: boolean;
    preMainPracticeLengthMinutes: number;
    preQualNumToMain: number;
    preQualPracticeLengthMinutes: number;
    qualCautionType: number;
    qualLaps: number;
    qualLengthMinutes: number;
    qualNumToMain: number;
    qualOpenDelaySeconds: number;
    qualScoresChampPoints: boolean;
    qualScoring: number;
    qualStyle: number;
    raceStyle: number;
}>;
export type HeatSesInfo = z.infer<typeof HeatSesInfoSchema>;
export declare const TrackTypeEnumSchema: z.ZodEnum<["dirt_road", "dirt_oval", "oval", "road"]>;
export type TrackTypeEnum = z.infer<typeof TrackTypeEnumSchema>;
export declare const TrackTypeSchema: z.ZodObject<{
    trackType: z.ZodEnum<["dirt_road", "dirt_oval", "oval", "road"]>;
}, "strip", z.ZodTypeAny, {
    trackType: "dirt_oval" | "dirt_road" | "oval" | "road";
}, {
    trackType: "dirt_oval" | "dirt_road" | "oval" | "road";
}>;
export type TrackType = z.infer<typeof TrackTypeSchema>;