flight-planner/dist/advisor.d.ts

Plan and route VFR flights

import { Aircraft } from './aircraft.js';
import type { RouteTrip, RouteOptions } from './navigation.types.js';
/**
 * Defines the severity level of an advisory.
 */
export declare enum AdvisoryLevel {
    Info = "INFO",
    Warning = "WARNING",
    Error = "ERROR"
}
/**
 * Represents an advisory message related to a flight plan.
 *
 * @interface Advisory
 * @property {string} code - A unique code identifying the advisory.
 * @property {AdvisoryLevel} level - The severity level of the advisory.
 * @property {any} [details] - Optional additional details about the advisory.
 */
export interface Advisory {
    code: string;
    level: AdvisoryLevel;
    details?: Record<string, unknown>;
}
/**
 * Validates a RouteTrip against various aviation regulations and best practices.
 *
 * @param routeTrip The flight plan's route trip.
 * @param aircraft The aircraft being used for the flight.
 * @param options Optional route configuration.
 * @returns An array of advisories.
 */
export declare function routeTripValidate(routeTrip: RouteTrip, aircraft: Aircraft, options?: RouteOptions): Advisory[];
/**
 * Checks if advisories contain any errors.
 *
 * @param advisories An array of advisories to check.
 * @returns True if any advisory has an error level, false otherwise.
 */
export declare function advisoryHasErrors(advisories: Advisory[]): boolean;