metar-taf-parser 0.0.1 → 0.0.2

package/dist/locale/zh-CN.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    CloudQuantity: {
+        BKN: "碎云",
+        FEW: "少量",
+        NSC: "没有明显的云。",
+        OVC: "多云",
+        SCT: "散云",
+        SKC: "天空晴朗",
+    },
+    CloudType: {
+        AC: "高积云",
+        AS: "高层云",
+        CB: "积雨云",
+        CC: "卷积云",
+        CI: "Cirrus",
+        CS: "卷层云",
+        CU: "积云",
+        NS: "雨层云",
+        SC: "层积云",
+        ST: "层云",
+        TCU: "高耸积云",
+    },
+    Descriptive: {
+        BC: "补丁",
+        BL: "吹",
+        DR: "低漂",
+        FZ: "冰冻",
+        MI: "浅",
+        PR: "部分的",
+        SH: "阵雨",
+        TS: "雷雨",
+    },
+    Error: {
+        prefix: "发生错误。 错误代码 n°",
+    },
+    ErrorCode: {
+        AirportNotFound: "找不到此消息的机场。",
+        InvalidMessage: "输入的消息无效。",
+    },
+    Intensity: {
+        "-": "光",
+        VC: "在附近",
+    },
+    "intensity-plus": "重的",
+    Phenomenon: {
+        BR: "薄雾",
+        DS: "沙尘暴",
+        DU: "弥漫的灰尘",
+        DZ: "细雨",
+        FC: "漏斗云",
+        FG: "雾",
+        FU: "烟",
+        GR: "冰雹",
+        GS: "小冰雹和/或雪粒",
+        HZ: "雾霾",
+        IC: "冰晶",
+        PL: "冰粒",
+        PO: "尘土或沙尘旋风",
+        PY: "喷",
+        RA: "雨",
+        SA: "沙",
+        SG: "雪粒",
+        SN: "雪",
+        SQ: "狂风",
+        SS: "沙暴",
+        UP: "未知降水",
+        VA: "火山灰",
+        TS: "雷雨",
+    },
+    Remark: {
+        AO1: "没有降水鉴别器的自动化站",
+        AO2: "带有降水鉴别器的自动化站",
+        BASED: "基于",
+        Ceiling: {
+            Height: "上限在 {0} 到 {1} 英尺之间变化",
+            Second: {
+                Location: "由位于 {1} 处的第二个传感器测量的 {0} 英尺的上限",
+            },
+        },
+        FCST: "预报",
+        FUNNELCLOUD: "漏斗云 ",
+    },
+    MetarFacade: {
+        InvalidIcao: "ICAO 代码无效。",
+    },
+    Converter: {
+        D: "减少",
+        E: "东",
+        N: "北",
+        NE: "东北",
+        NSC: "无明显变化",
+        NW: "西北",
+        S: "南",
+        SE: "东南",
+        SW: "西南",
+        U: "上升",
+        VRB: "多变的",
+        W: "西",
+    },
+    WeatherChangeType: {
+        FM: "从",
+        BECMG: "变得",
+        TEMPO: "暂时的",
+        PROB: "可能性",
+    },
+    TimeIndicator: {
+        AT: "在",
+        TL: "直到",
+    },
+};

package/dist/model/enum.d.ts

@@ -0,0 +1,221 @@
+export declare enum CloudQuantity {
+    /**
+     * Sky clear
+     */
+    SKC = "SKC",
+    /**
+     * Few
+     */
+    FEW = "FEW",
+    /**
+     * Broken
+     */
+    BKN = "BKN",
+    /**
+     * Scattered
+     */
+    SCT = "SCT",
+    /**
+     * Overcast
+     */
+    OVC = "OVC",
+    /**
+     * No significant cloud
+     */
+    NSC = "NSC"
+}
+export declare enum CloudType {
+    /**
+     * Cumulonimbus
+     */
+    CB = "CB",
+    /**
+     * Towering cumulus, cumulus congestus
+     */
+    TCU = "TCU",
+    /**
+     * Cirrus
+     */
+    CI = "CI",
+    /**
+     * Cirrocumulus
+     */
+    CC = "CC",
+    /**
+     * Cirrostratus
+     */
+    CS = "CS",
+    /**
+     * Altocumulus
+     */
+    AC = "AC",
+    /**
+     * Stratus
+     */
+    ST = "ST",
+    /**
+     * Cumulus
+     */
+    CU = "CU",
+    /**
+     * Astrostratus
+     */
+    AS = "AS",
+    /**
+     * Nimbostratus
+     */
+    NS = "NS",
+    /**
+     * Stratocumulus
+     */
+    SC = "SC"
+}
+/**
+ * Moderate has no qualifier.
+ */
+export declare enum Intensity {
+    LIGHT = "-",
+    /**
+     * Heavy or well-developed
+     */
+    HEAVY = "+",
+    IN_VICINITY = "VC"
+}
+export declare enum Descriptive {
+    SHOWERS = "SH",
+    SHALLOW = "MI",
+    PATCHES = "BC",
+    PARTIAL = "PR",
+    DRIFTING = "DR",
+    THUNDERSTORM = "TS",
+    BLOWING = "BL",
+    FREEZING = "FZ"
+}
+export declare enum Phenomenon {
+    RAIN = "RA",
+    DRIZZLE = "DZ",
+    SNOW = "SN",
+    SNOW_GRAINS = "SG",
+    ICE_PELLETS = "PL",
+    ICE_CRYSTALS = "IC",
+    HAIL = "GR",
+    SMALL_HAIL = "GS",
+    UNKNOW_PRECIPITATION = "UP",
+    FOG = "FG",
+    VOLCANIC_ASH = "VA",
+    MIST = "BR",
+    HAZE = "HZ",
+    WIDESPREAD_DUST = "DU",
+    SMOKE = "FU",
+    SAND = "SA",
+    SPRAY = "PY",
+    SQUALL = "SQ",
+    SAND_WHIRLS = "PO",
+    DUSTSTORM = "DS",
+    SANDSTORM = "SS",
+    FUNNEL_CLOUD = "FC"
+}
+export declare enum TimeIndicator {
+    AT = "AT",
+    FM = "FM",
+    TL = "TL"
+}
+/**
+ * https://www.aviationweather.gov/taf/decoder
+ */
+export declare enum WeatherChangeType {
+    /**
+     * FROM Group
+     *
+     * ie. `FM1600`
+     *
+     * The FM group is used when a rapid change, usually occuring in less than one
+     * hour, in prevailing conditions is expected. Typically, a rapid change of
+     * prevailing conditions to more or less a completely new set of prevailing
+     * conditions is associated with a synoptic feature passing through the
+     * terminal area (cold or warm frontal passage). Appended to the FM indicator
+     * is the four-digit hour and minute the change is expected to begin and
+     * continues until the next change group or until the end of the current
+     * forecast.
+     *
+     * A FM group will mark the beginning of a new line in a TAF report. Each FM
+     * group contains all the required elements -- wind, visibility, weather, and
+     * sky condition. Weather will be omitted in FM groups when it is not
+     * significant to aviation. FM groups will not include the contraction NSW.
+     *
+     * Examples:
+     *
+     *  1. `FM0100 SKC` - After 0100Z sky clear
+     *  2. `FM1430 OVC020` - After 1430Z ceiling two thousand overcast
+     */
+    FM = "FM",
+    /**
+     * BECOMING Group
+     *
+     * ie. `BECMG 2224`
+     *
+     * The BECMG group is used when a gradual change in conditions is expected
+     * over a longer time period, usually two hours. The time period when the
+     * change is expected is a four-digit group with the beginning hour and ending
+     * hour of the change period which follows the BECMG indicator. The gradual
+     * change will occur at an unspecified time within this time period. Only the
+     * conditions are carried over from the previous time group.
+     *
+     * Example:
+     *
+     *  1. `OVC012 BECMG 1416 BKN020` - Ceiling one thousand two hundred overcast.
+     *     Then a gradual change to ceiling two thousand broken between 1400Z and
+     *     1600Z.
+     */
+    BECMG = "BECMG",
+    /**
+     * TEMPORARY Group
+     *
+     * ie. `TEMPO 1316`
+     *
+     * The TEMPO group is used for any conditions in wind, visibility, weather, or
+     * sky condition which are expected to last for generally less than an hour at
+     * a time (occasional), and are expected to occur during less than half the
+     * time period. The TEMPO indicator is followed by a four-digit group giving
+     * the beginning hour and ending hour of the time period during which the
+     * temporary conditions are expected. Only the changing forecast
+     * meteorological conditions are included in TEMPO groups. The omitted
+     * conditions are carried over from the previous time group.
+     *
+     * Examples:
+     *
+     *  1. `SCT030 TEMPO 1923 BKN030` - Three thousand scattered with occasional
+     *     ceilings three thousand broken between 1900Z and 2300Z.
+     *  2. `4SM HZ TEMPO 0006 2SM BR HZ` - Visibility four in haze with occasional
+     *     visibility two in mist and haze between 0000Z and 0600Z.
+     */
+    TEMPO = "TEMPO",
+    /**
+     * Probability Forecast
+     *
+     * ie. `PROB40 0006`
+     *
+     * The probability or chance of thunderstorms or other precipitation events
+     * occuring, along with associated weather conditions (wind, visibility, and
+     * sky conditions).
+     *
+     * The PROB40 group is used when the occurrence of thunderstorms or
+     * precipitation is in the 30% to less than 50% range, thus the probability
+     * value 40 is appended to the PROB contraction. This is followed by a
+     * four-digit group giving the beginning hour and ending hour of the time
+     * period during which the thunderstorms or precipitation is expected.
+     *
+     * Note: PROB40 will not be shown during the first six hours of a forecast.
+     *
+     * Examples:
+     *
+     *  1. `PROB40 2102 1/2SM +TSRA` - Chance between 2100Z and 0200Z of
+     *     visibility one-half thunderstorm, heavy rain.
+     *  2. `PROB40 1014 1SM RASN` - Chance between 1000Z and 1400Z of visibility
+     *     one rain and snow.
+     *  3. `PROB40 2024 2SM FZRA` - Chance between 2000Z and 0000Z of visibility
+     *     two freezing rain.
+  
+     */
+    PROB = "PROB"
+}

package/dist/model/enum.js

@@ -0,0 +1,231 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeatherChangeType = exports.TimeIndicator = exports.Phenomenon = exports.Descriptive = exports.Intensity = exports.CloudType = exports.CloudQuantity = void 0;
+var CloudQuantity;
+(function (CloudQuantity) {
+    /**
+     * Sky clear
+     */
+    CloudQuantity["SKC"] = "SKC";
+    /**
+     * Few
+     */
+    CloudQuantity["FEW"] = "FEW";
+    /**
+     * Broken
+     */
+    CloudQuantity["BKN"] = "BKN";
+    /**
+     * Scattered
+     */
+    CloudQuantity["SCT"] = "SCT";
+    /**
+     * Overcast
+     */
+    CloudQuantity["OVC"] = "OVC";
+    /**
+     * No significant cloud
+     */
+    CloudQuantity["NSC"] = "NSC";
+})(CloudQuantity = exports.CloudQuantity || (exports.CloudQuantity = {}));
+var CloudType;
+(function (CloudType) {
+    /**
+     * Cumulonimbus
+     */
+    CloudType["CB"] = "CB";
+    /**
+     * Towering cumulus, cumulus congestus
+     */
+    CloudType["TCU"] = "TCU";
+    /**
+     * Cirrus
+     */
+    CloudType["CI"] = "CI";
+    /**
+     * Cirrocumulus
+     */
+    CloudType["CC"] = "CC";
+    /**
+     * Cirrostratus
+     */
+    CloudType["CS"] = "CS";
+    /**
+     * Altocumulus
+     */
+    CloudType["AC"] = "AC";
+    /**
+     * Stratus
+     */
+    CloudType["ST"] = "ST";
+    /**
+     * Cumulus
+     */
+    CloudType["CU"] = "CU";
+    /**
+     * Astrostratus
+     */
+    CloudType["AS"] = "AS";
+    /**
+     * Nimbostratus
+     */
+    CloudType["NS"] = "NS";
+    /**
+     * Stratocumulus
+     */
+    CloudType["SC"] = "SC";
+})(CloudType = exports.CloudType || (exports.CloudType = {}));
+/**
+ * Moderate has no qualifier.
+ */
+var Intensity;
+(function (Intensity) {
+    Intensity["LIGHT"] = "-";
+    /**
+     * Heavy or well-developed
+     */
+    Intensity["HEAVY"] = "+";
+    Intensity["IN_VICINITY"] = "VC";
+})(Intensity = exports.Intensity || (exports.Intensity = {}));
+var Descriptive;
+(function (Descriptive) {
+    Descriptive["SHOWERS"] = "SH";
+    Descriptive["SHALLOW"] = "MI";
+    Descriptive["PATCHES"] = "BC";
+    Descriptive["PARTIAL"] = "PR";
+    Descriptive["DRIFTING"] = "DR";
+    Descriptive["THUNDERSTORM"] = "TS";
+    Descriptive["BLOWING"] = "BL";
+    Descriptive["FREEZING"] = "FZ";
+})(Descriptive = exports.Descriptive || (exports.Descriptive = {}));
+var Phenomenon;
+(function (Phenomenon) {
+    Phenomenon["RAIN"] = "RA";
+    Phenomenon["DRIZZLE"] = "DZ";
+    Phenomenon["SNOW"] = "SN";
+    Phenomenon["SNOW_GRAINS"] = "SG";
+    Phenomenon["ICE_PELLETS"] = "PL";
+    Phenomenon["ICE_CRYSTALS"] = "IC";
+    Phenomenon["HAIL"] = "GR";
+    Phenomenon["SMALL_HAIL"] = "GS";
+    Phenomenon["UNKNOW_PRECIPITATION"] = "UP";
+    Phenomenon["FOG"] = "FG";
+    Phenomenon["VOLCANIC_ASH"] = "VA";
+    Phenomenon["MIST"] = "BR";
+    Phenomenon["HAZE"] = "HZ";
+    Phenomenon["WIDESPREAD_DUST"] = "DU";
+    Phenomenon["SMOKE"] = "FU";
+    Phenomenon["SAND"] = "SA";
+    Phenomenon["SPRAY"] = "PY";
+    Phenomenon["SQUALL"] = "SQ";
+    Phenomenon["SAND_WHIRLS"] = "PO";
+    Phenomenon["DUSTSTORM"] = "DS";
+    Phenomenon["SANDSTORM"] = "SS";
+    Phenomenon["FUNNEL_CLOUD"] = "FC";
+})(Phenomenon = exports.Phenomenon || (exports.Phenomenon = {}));
+var TimeIndicator;
+(function (TimeIndicator) {
+    TimeIndicator["AT"] = "AT";
+    TimeIndicator["FM"] = "FM";
+    TimeIndicator["TL"] = "TL";
+})(TimeIndicator = exports.TimeIndicator || (exports.TimeIndicator = {}));
+/**
+ * https://www.aviationweather.gov/taf/decoder
+ */
+var WeatherChangeType;
+(function (WeatherChangeType) {
+    /**
+     * FROM Group
+     *
+     * ie. `FM1600`
+     *
+     * The FM group is used when a rapid change, usually occuring in less than one
+     * hour, in prevailing conditions is expected. Typically, a rapid change of
+     * prevailing conditions to more or less a completely new set of prevailing
+     * conditions is associated with a synoptic feature passing through the
+     * terminal area (cold or warm frontal passage). Appended to the FM indicator
+     * is the four-digit hour and minute the change is expected to begin and
+     * continues until the next change group or until the end of the current
+     * forecast.
+     *
+     * A FM group will mark the beginning of a new line in a TAF report. Each FM
+     * group contains all the required elements -- wind, visibility, weather, and
+     * sky condition. Weather will be omitted in FM groups when it is not
+     * significant to aviation. FM groups will not include the contraction NSW.
+     *
+     * Examples:
+     *
+     *  1. `FM0100 SKC` - After 0100Z sky clear
+     *  2. `FM1430 OVC020` - After 1430Z ceiling two thousand overcast
+     */
+    WeatherChangeType["FM"] = "FM";
+    /**
+     * BECOMING Group
+     *
+     * ie. `BECMG 2224`
+     *
+     * The BECMG group is used when a gradual change in conditions is expected
+     * over a longer time period, usually two hours. The time period when the
+     * change is expected is a four-digit group with the beginning hour and ending
+     * hour of the change period which follows the BECMG indicator. The gradual
+     * change will occur at an unspecified time within this time period. Only the
+     * conditions are carried over from the previous time group.
+     *
+     * Example:
+     *
+     *  1. `OVC012 BECMG 1416 BKN020` - Ceiling one thousand two hundred overcast.
+     *     Then a gradual change to ceiling two thousand broken between 1400Z and
+     *     1600Z.
+     */
+    WeatherChangeType["BECMG"] = "BECMG";
+    /**
+     * TEMPORARY Group
+     *
+     * ie. `TEMPO 1316`
+     *
+     * The TEMPO group is used for any conditions in wind, visibility, weather, or
+     * sky condition which are expected to last for generally less than an hour at
+     * a time (occasional), and are expected to occur during less than half the
+     * time period. The TEMPO indicator is followed by a four-digit group giving
+     * the beginning hour and ending hour of the time period during which the
+     * temporary conditions are expected. Only the changing forecast
+     * meteorological conditions are included in TEMPO groups. The omitted
+     * conditions are carried over from the previous time group.
+     *
+     * Examples:
+     *
+     *  1. `SCT030 TEMPO 1923 BKN030` - Three thousand scattered with occasional
+     *     ceilings three thousand broken between 1900Z and 2300Z.
+     *  2. `4SM HZ TEMPO 0006 2SM BR HZ` - Visibility four in haze with occasional
+     *     visibility two in mist and haze between 0000Z and 0600Z.
+     */
+    WeatherChangeType["TEMPO"] = "TEMPO";
+    /**
+     * Probability Forecast
+     *
+     * ie. `PROB40 0006`
+     *
+     * The probability or chance of thunderstorms or other precipitation events
+     * occuring, along with associated weather conditions (wind, visibility, and
+     * sky conditions).
+     *
+     * The PROB40 group is used when the occurrence of thunderstorms or
+     * precipitation is in the 30% to less than 50% range, thus the probability
+     * value 40 is appended to the PROB contraction. This is followed by a
+     * four-digit group giving the beginning hour and ending hour of the time
+     * period during which the thunderstorms or precipitation is expected.
+     *
+     * Note: PROB40 will not be shown during the first six hours of a forecast.
+     *
+     * Examples:
+     *
+     *  1. `PROB40 2102 1/2SM +TSRA` - Chance between 2100Z and 0200Z of
+     *     visibility one-half thunderstorm, heavy rain.
+     *  2. `PROB40 1014 1SM RASN` - Chance between 1000Z and 1400Z of visibility
+     *     one rain and snow.
+     *  3. `PROB40 2024 2SM FZRA` - Chance between 2000Z and 0000Z of visibility
+     *     two freezing rain.
+  
+     */
+    WeatherChangeType["PROB"] = "PROB";
+})(WeatherChangeType = exports.WeatherChangeType || (exports.WeatherChangeType = {}));

package/dist/{lib/model → model}/model.d.ts

@@ -1,4 +1,4 @@
-import { CloudQuantity, CloudType, Descriptive, Phenomenon, TimeIndicator, WeatherChangeType } from "model/enum";
+import { CloudQuantity, CloudType, Descriptive, Phenomenon, TimeIndicator, WeatherChangeType } from "../model/enum";
 export interface ICountry {
     name: string;
 }
@@ -69,13 +69,19 @@ export interface IAbstractValidity {
     startDay: number;
     startHour: number;
 }
-export interface IAbstractWeatherCode extends IAbstractWeatherContainer {
+/**
+ * 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;
-    time: string;
     airport: IAirport;
     message: string;
     station: string;
-    trends: unknown[];
+    trends: IAbstractTrend[];
 }
 export interface IMetar extends IAbstractWeatherCode {
     temperature: number;
@@ -84,21 +90,22 @@ export interface IMetar extends IAbstractWeatherCode {
     nosig: boolean;
     auto: boolean;
     runwaysInfo: IRunwayInfo[];
+    trends: IMetarTrend[];
 }
 export interface ITAF extends IAbstractWeatherCode {
     validity: IAbstractValidity;
     maxTemperature: number;
     minTemperature: number;
     amendment: boolean;
+    trends: ITAFTrend[];
 }
 export interface IAbstractTrend extends IAbstractWeatherContainer {
     type: WeatherChangeType;
 }
-export interface IMetarTrendTime {
+export interface IMetarTrendTime extends ITime {
     type: TimeIndicator;
-    time: string;
 }
-export interface MetarTrend extends IAbstractTrend {
+export interface IMetarTrend extends IAbstractTrend {
     times: IMetarTrendTime[];
 }
 export interface ITAFTrend extends IAbstractTrend {

package/dist/{lib/model → model}/model.js

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

package/dist/parser/parser.d.ts

@@ -0,0 +1,66 @@
+import { IAbstractWeatherContainer, IMetar, IMetarTrend, ITemperatureDated, IValidity, IWeatherCondition } 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): IValidity;
+/**
+ * Abstract class.
+ * Base parser.
+ */
+export declare abstract class AbstractParser {
+    #private;
+    FM: string;
+    TEMPO: string;
+    BECMG: string;
+    RMK: string;
+    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;
+    private locale;
+    AT: string;
+    TL: string;
+    constructor(locale: Locale);
+    /**
+     * 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;
+}
+export declare class RemarkParser {
+    #private;
+    private locale;
+    constructor(locale: Locale);
+    parse(code: string): string[];
+}