metar-taf-parser 3.1.2 → 4.0.2

package/dist/model/model.d.ts

@@ -1,188 +0,0 @@
-import { CloudQuantity, CloudType, Descriptive, ValueIndicator, Phenomenon, TimeIndicator, WeatherChangeType, DistanceUnit, RunwayInfoTrend, RunwayInfoUnit, Intensity } from "../model/enum";
-import { Remark } from "../command/remark";
-export interface ICountry {
-    name: string;
-}
-export interface IAirport {
-    name: string;
-    city: string;
-    country: string;
-    iata: string;
-    icao: string;
-    latitude: string;
-    longitude: string;
-    altitude: string;
-    timezone: string;
-    dst: boolean;
-    tzDatabase: unknown;
-}
-export interface IWind {
-    speed: number;
-    direction: string;
-    degrees?: number;
-    gust?: number;
-    minVariation?: number;
-    maxVariation?: number;
-    unit: string;
-}
-export interface IWindShear extends IWind {
-    height: number;
-}
-export interface Distance {
-    indicator?: ValueIndicator;
-    value: number;
-    unit: DistanceUnit;
-    /** No Directional Visibility */
-    ndv?: true;
-}
-export declare type Visibility = Distance & {
-    /**
-     * Never in North American METARs
-     */
-    min?: {
-        /** Always in meters */
-        value: number;
-        direction: string;
-    };
-};
-export interface IWeatherCondition {
-    intensity?: Intensity;
-    descriptive?: Descriptive;
-    phenomenons: Phenomenon[];
-}
-export declare function isWeatherConditionValid(weather: IWeatherCondition): boolean;
-export interface ITemperatureDated {
-    temperature: number;
-    day: number;
-    hour: number;
-}
-export interface IRunwayInfo {
-    name: string;
-    minRange: number;
-    maxRange?: number;
-    /**
-     * Only used in North American runway ranges (feet unit of measurement)
-     */
-    indicator?: ValueIndicator;
-    /**
-     * Only used in IACO runway ranges (meters unit of measurement)
-     */
-    trend?: RunwayInfoTrend;
-    unit: RunwayInfoUnit;
-}
-export interface ICloud {
-    height?: number;
-    quantity: CloudQuantity;
-    type?: CloudType;
-}
-export interface IAbstractWeatherContainer {
-    wind?: IWind;
-    visibility?: Visibility;
-    verticalVisibility?: number;
-    windShear?: IWindShear;
-    cavok?: true;
-    remark?: string;
-    remarks: Remark[];
-    clouds: ICloud[];
-    weatherConditions: IWeatherCondition[];
-}
-export interface IAbstractValidity {
-    startDay: number;
-    startHour: number;
-}
-/**
- * Exclusive for the TS port (because python has `time()` and js does not)
- */
-export interface ITime {
-    hour: number;
-    minute: number;
-}
-export interface IAbstractWeatherCode extends IAbstractWeatherContainer, ITime {
-    day: number;
-    airport?: IAirport;
-    message: string;
-    station: string;
-    trends: IAbstractTrend[];
-}
-export interface IAbstractWeatherCodeDated extends IAbstractWeatherCode {
-    issued: Date;
-}
-export interface IMetar extends IAbstractWeatherCode {
-    temperature?: number;
-    dewPoint?: number;
-    altimeter?: number;
-    nosig?: true;
-    auto?: true;
-    runwaysInfo: IRunwayInfo[];
-    /**
-     * Not used in North America
-     */
-    trends: IMetarTrend[];
-}
-export interface ITAF extends IAbstractWeatherCode {
-    validity: IValidity;
-    maxTemperature?: ITemperatureDated;
-    minTemperature?: ITemperatureDated;
-    amendment?: true;
-    trends: TAFTrend[];
-}
-export interface IAbstractTrend extends IAbstractWeatherContainer {
-    type: WeatherChangeType;
-}
-export interface IMetarTrendTime extends ITime {
-    type: TimeIndicator;
-}
-export interface IMetarTrend extends IAbstractTrend {
-    times: IMetarTrendTime[];
-}
-export interface IBaseTAFTrend extends IAbstractTrend {
-    /**
-     * Will not be found on FM trends. May exist on others.
-     *
-     * If does not exist, probability is > 40%
-     */
-    probability?: number;
-    /**
-     * All trends have `startDay` and `startHour` defined. Additionally:
-     *
-     * - FM trends also have `startMinutes`. They **DO NOT** have an explicit end
-     *   validity (it is implied by the following FM).
-     * - All others (PROB, TEMPO, BECMG) have `endDay` and `endHour`.
-     *
-     * All properties are allowed to be accessed (as optionals), but if you want
-     * type guarantees, you can check the trend type. For example:
-     *
-     * ```ts
-     * switch (trend.type) {
-     *   case WeatherChangeType.FM:
-     *     // trend.validity now has startMinutes defined
-     *     break;
-     *   case WeatherChangeType.PROB:
-     *   case WeatherChangeType.BECMG:
-     *   case WeatherChangeType.TEMPO:
-     *     // trend.validity now has endHour, endDay defined
-     * }
-     * ```
-     */
-    validity: IAbstractValidity & Partial<IFMValidity> & Partial<IValidity>;
-}
-export declare type TAFTrend = IBaseTAFTrend & ({
-    type: WeatherChangeType.FM;
-    validity: IFMValidity;
-} | {
-    type: WeatherChangeType;
-    validity: IValidity;
-});
-export interface IEndValidity {
-    endHour: number;
-    endDay: number;
-}
-export interface IValidity extends IAbstractValidity, IEndValidity {
-}
-export interface IValidityDated extends IAbstractValidity, IEndValidity {
-    start: Date;
-    end: Date;
-}
-export interface IFMValidity extends IAbstractValidity {
-    startMinutes: number;
-}

package/dist/model/model.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWeatherConditionValid = void 0;
-const enum_1 = require("../model/enum");
-function isWeatherConditionValid(weather) {
-    return (weather.phenomenons.length !== 0 ||
-        weather.descriptive == enum_1.Descriptive.THUNDERSTORM ||
-        (weather.intensity === enum_1.Intensity.IN_VICINITY &&
-            weather.descriptive == enum_1.Descriptive.SHOWERS));
-}
-exports.isWeatherConditionValid = isWeatherConditionValid;

package/dist/parser/parser.d.ts

@@ -1,111 +0,0 @@
-import { Remark } from "../command/remark";
-import { IAbstractWeatherContainer, IMetar, IMetarTrend, ITAF, TAFTrend, ITemperatureDated, IValidity, IWeatherCondition, IValidityDated } from "../model/model";
-import { Locale } from "../commons/i18n";
-/**
- * Parses the temperature in a TAF
- * @param input the string containing the temperature
- * @returns TemperatureDated object
- */
-export declare function parseTemperature(input: string): ITemperatureDated;
-/**
- * Parses validity of a TAF or a TAFTrend
- * @param input the string containing the validity
- * @returns Validity object
- */
-export declare function parseValidity(input: string, date?: Date): IValidityDated | IValidity;
-/**
- * Abstract class.
- * Base parser.
- */
-export declare abstract class AbstractParser {
-    #private;
-    protected locale: Locale;
-    FM: string;
-    TEMPO: string;
-    BECMG: string;
-    RMK: string;
-    constructor(locale: Locale);
-    parseWeatherCondition(input: string): IWeatherCondition;
-    /**
-     * Parses the message into different tokens
-     * @param input The metar or TAF as string
-     * @returns List of tokens
-     */
-    tokenize(input: string): string[];
-    /**
-     * Common parse method for METAR, TAF and trends object
-     * @param abstractWeatherCode the object to update
-     * @param input The token to parse
-     * @returns True if the token was parsed false otherwise
-     */
-    generalParse(abstractWeatherContainer: IAbstractWeatherContainer, input: string): boolean;
-}
-export declare class MetarParser extends AbstractParser {
-    #private;
-    AT: string;
-    TL: string;
-    /**
-     * Parses a trend of a metar
-     * @param index the index starting the trend in the list
-     * @param trend The trend to update
-     * @param trendParts array of tokens
-     * @returns the last index of the token that was last parsed
-     */
-    parseTrend(index: number, trend: IMetarTrend, trendParts: string[]): number;
-    /**
-     * Parses an message and returns a METAR
-     * @param input The message to parse
-     * @returns METAR
-     */
-    parse(input: string): IMetar;
-}
-/**
- * Parser for TAF messages
- */
-export declare class TAFParser extends AbstractParser {
-    #private;
-    TAF: string;
-    PROB: string;
-    TX: string;
-    TN: string;
-    /**
-     * the message to parse
-     * @param input
-     * @returns a TAF object
-     * @throws ParseError if the message is invalid
-     */
-    parse(input: string): ITAF;
-    /**
-     * Format the message as a multiple line code so each line can be parsed
-     * @param tafCode The base message
-     * @returns a list of string representing the lines of the message
-     */
-    extractLinesTokens(tafCode: string): string[][];
-    /**
-     * Parses the tokens of the line and updates the TAF object
-     * @param taf TAF object to update
-     * @param lineTokens the array of tokens representing a line
-     */
-    parseLine(taf: ITAF, lineTokens: string[]): void;
-    /**
-     * Finds a non-FM validity in a line
-     * @param index the index at which the array should be parsed
-     * @param line The array of string containing the line
-     * @param trend The trend object to update
-     */
-    findLineValidity(index: number, line: string[]): IValidity | undefined;
-    /**
-     * Parses a trend of the TAF
-     * @param index the index at which the array should be parsed
-     * @param line The array of string containing the line
-     * @param trend The trend object to update
-     */
-    parseTrend(index: number, line: string[], trend: TAFTrend): void;
-    makeEmptyTAFTrend(): Omit<TAFTrend, "type" | "validity">;
-}
-export declare class RemarkParser {
-    #private;
-    private locale;
-    constructor(locale: Locale);
-    parse(code: string): Remark[];
-}