@squawk/flightplan 0.6.3 → 0.6.4

package/README.md

@@ -33,7 +33,7 @@ const resolver = createFlightplanResolver({
   procedures: createProcedureResolver({ data: usBundledProcedures.records }),
 });
 
-const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
 for (const element of route.elements) {
   console.log(element.type, element.raw);
 }
@@ -173,13 +173,13 @@ to the first `byIdent` match.
 Computes the total great-circle route distance and optional estimated time
 enroute from a parsed route. Walks the same ordered point sequence as the
 geometry helpers below, so distance and geometry stay in agreement. Airway
-segments use FAA-published per-segment distances when available, falling back
-to great-circle computation.
+segments use the FAA-published per-segment distance where the data carries a
+positive one, falling back to great-circle computation otherwise.
 
 ```typescript
 import { computeRouteDistance } from '@squawk/flightplan';
 
-const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
 const result = computeRouteDistance(route, 450);
 console.log(result.totalDistanceNm, result.estimatedTimeEnrouteHrs);
 ```
@@ -216,7 +216,7 @@ wind correction angle is zero.
 ```typescript
 import { computeRouteTiming } from '@squawk/flightplan';
 
-const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
 const result = computeRouteTiming(route, {
   trueAirspeedKt: 450,
   windProvider: (lat, lon) => ({ directionDeg: 270, speedKt: 80 }),
@@ -269,7 +269,7 @@ two drawable points, since a `LineString` requires at least two positions.
 ```typescript
 import { routeToLineString } from '@squawk/flightplan';
 
-const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
 const line = routeToLineString(route);
 if (line) {
   map.addSource('route', { type: 'geojson', data: line });

package/dist/resolver.d.ts

@@ -263,7 +263,7 @@ export interface FlightplanResolver {
  *   procedures: createProcedureResolver({ data: usBundledProcedures.records }),
  * });
  *
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * for (const element of route.elements) {
  *   console.log(element.type, element.raw);
  * }

package/dist/resolver.js

@@ -104,8 +104,8 @@ function tryAirport(token, airports) {
  * the arrival airport - but since the route is parsed left-to-right,
  * the most recent airport is the best available hint).
  *
- * Accepts both the bare CIFP identifier (e.g. `NUBLE4`) and the dotted
- * identifier-with-transition form (e.g. `NUBLE4.JJIMY`). When a
+ * Accepts both the bare CIFP identifier (e.g. `DEEZZ6`) and the dotted
+ * identifier-with-transition form (e.g. `DEEZZ6.CANDR`). When a
  * transition is supplied it is forwarded to the procedure resolver so
  * that the transition's legs are merged into the expansion.
  */
@@ -211,7 +211,7 @@ function tryNavaid(token, navaids, anchor) {
  *   procedures: createProcedureResolver({ data: usBundledProcedures.records }),
  * });
  *
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * for (const element of route.elements) {
  *   console.log(element.type, element.raw);
  * }

package/dist/route-distance.d.ts

@@ -55,14 +55,15 @@ export interface RouteDistanceResult {
  * indicate which parts of the route could not contribute to the distance
  * calculation.
  *
- * Airway segments use the FAA-published `distanceToNextNm` values when
- * available, falling back to great-circle computation otherwise.
+ * Airway segments use the FAA-published `distanceToNextNm` value where the
+ * source publishes a positive one, falling back to great-circle computation
+ * otherwise.
  *
  * ```typescript
  * import { createFlightplanResolver, computeRouteDistance } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const result = computeRouteDistance(route, 450);
  * console.log(result.totalDistanceNm, result.estimatedTimeEnrouteHrs);
  * ```

package/dist/route-distance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"route-distance.d.ts","sourceRoot":"","sources":["../src/route-distance.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAO/D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,8FAA8F;IAC9F,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,2DAA2D;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C;;;;OAIG;IACH,kBAAkB,EAAE,YAAY,EAAE,CAAC;CACpC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,WAAW,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,mBAAmB,CAsCrB"}
+{"version":3,"file":"route-distance.d.ts","sourceRoot":"","sources":["../src/route-distance.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAO/D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,8FAA8F;IAC9F,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,2DAA2D;IAC3D,eAAe,EAAE,MAAM,CAAC;IACxB,uFAAuF;IACvF,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C;;;;OAIG;IACH,kBAAkB,EAAE,YAAY,EAAE,CAAC;CACpC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,WAAW,EAClB,aAAa,CAAC,EAAE,MAAM,GACrB,mBAAmB,CAsCrB"}

package/dist/route-distance.js

@@ -20,14 +20,15 @@ import { extractGeoPoints } from './route-geometry.js';
  * indicate which parts of the route could not contribute to the distance
  * calculation.
  *
- * Airway segments use the FAA-published `distanceToNextNm` values when
- * available, falling back to great-circle computation otherwise.
+ * Airway segments use the FAA-published `distanceToNextNm` value where the
+ * source publishes a positive one, falling back to great-circle computation
+ * otherwise.
  *
  * ```typescript
  * import { createFlightplanResolver, computeRouteDistance } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const result = computeRouteDistance(route, 450);
  * console.log(result.totalDistanceNm, result.estimatedTimeEnrouteHrs);
  * ```

package/dist/route-geometry.d.ts

@@ -37,14 +37,14 @@ export interface GeoPoint {
     lon: number;
     /**
      * Pre-computed distance to the next point along an airway segment in
-     * nautical miles, if available from the source data.
+     * nautical miles, when the source data publishes a positive value.
      */
     precomputedDistanceToNextNm?: number;
 }
 /**
  * Walks the route elements and extracts an ordered array of geographic
- * points. Duplicate consecutive points (e.g. an airway entry fix that
- * matches the preceding waypoint) are suppressed.
+ * points. Duplicate consecutive points (e.g. an airway entry fix at the same
+ * position as the preceding waypoint, within about a metre) are suppressed.
  *
  * Also collects all `unresolved` elements encountered during the walk.
  *
@@ -74,7 +74,7 @@ export declare function extractGeoPoints(elements: RouteElement[]): {
  * import { createFlightplanResolver, extractRoutePoints } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const points = extractRoutePoints(route);
  * ```
  *
@@ -94,7 +94,7 @@ export declare function extractRoutePoints(route: ParsedRoute): RoutePoint[];
  * import { createFlightplanResolver, routeToLineString } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const line = routeToLineString(route);
  * if (line) {
  *   map.addSource('route', { type: 'geojson', data: line });

package/dist/route-geometry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"route-geometry.d.ts","sourceRoot":"","sources":["../src/route-geometry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAM/D;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;CACb;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACtC;AAgBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,YAAY,EAAE,GAAG;IAC1D,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,kBAAkB,EAAE,YAAY,EAAE,CAAC;CACpC,CA6EA;AAMD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,CAGnE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,SAAS,CAS5E"}
+{"version":3,"file":"route-geometry.d.ts","sourceRoot":"","sources":["../src/route-geometry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAM/D;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;CACb;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACtC;AAuBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,YAAY,EAAE,GAAG;IAC1D,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,kBAAkB,EAAE,YAAY,EAAE,CAAC;CACpC,CA8EA;AAMD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,EAAE,CAGnE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,SAAS,CAS5E"}

package/dist/route-geometry.js

@@ -11,8 +11,15 @@
 // ---------------------------------------------------------------------------
 // Internal helpers
 // ---------------------------------------------------------------------------
-/** Epsilon for comparing coordinates to detect duplicate points. */
-const COORD_EPSILON = 1e-9;
+/**
+ * Epsilon in decimal degrees for treating two consecutive points as the same
+ * position. The data packages round coordinates to different precisions
+ * (airway waypoints to six decimals, fixes and navaids to eight), so the same
+ * fix reached through two of them can differ by up to 5e-7 degrees. 1e-5
+ * degrees is about a metre: far above that rounding noise and far below the
+ * spacing of any two distinct route points.
+ */
+const COORD_EPSILON = 1e-5;
 /**
  * Returns true if two points share the same coordinates (within epsilon).
  */
@@ -21,8 +28,8 @@ function samePosition(a, b) {
 }
 /**
  * Walks the route elements and extracts an ordered array of geographic
- * points. Duplicate consecutive points (e.g. an airway entry fix that
- * matches the preceding waypoint) are suppressed.
+ * points. Duplicate consecutive points (e.g. an airway entry fix at the same
+ * position as the preceding waypoint, within about a metre) are suppressed.
  *
  * Also collects all `unresolved` elements encountered during the walk.
  *
@@ -70,9 +77,10 @@ export function extractGeoPoints(elements) {
                         lat: wp.lat,
                         lon: wp.lon,
                     };
-                    // Only carry precomputed distance for non-last waypoints (the
-                    // last waypoint's distanceToNextNm points beyond this segment).
-                    if (!isLast && wp.distanceToNextNm !== undefined) {
+                    // Only carry a published distance for non-last waypoints (the last
+                    // waypoint's distanceToNextNm points beyond this segment), and only
+                    // a positive one: a zero means the source published no distance.
+                    if (!isLast && wp.distanceToNextNm !== undefined && wp.distanceToNextNm > 0) {
                         point.precomputedDistanceToNextNm = wp.distanceToNextNm;
                     }
                     emit(point);
@@ -118,7 +126,7 @@ export function extractGeoPoints(elements) {
  * import { createFlightplanResolver, extractRoutePoints } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const points = extractRoutePoints(route);
  * ```
  *
@@ -141,7 +149,7 @@ export function extractRoutePoints(route) {
  * import { createFlightplanResolver, routeToLineString } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const line = routeToLineString(route);
  * if (line) {
  *   map.addSource('route', { type: 'geojson', data: line });

package/dist/route-timing.d.ts

@@ -152,7 +152,7 @@ export interface RouteTimingResult {
  * import { createFlightplanResolver, computeRouteTiming } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const result = computeRouteTiming(route, {
  *   trueAirspeedKt: 450,
  *   windProvider: (lat, lon) => ({ directionDeg: 270, speedKt: 80 }),

package/dist/route-timing.js

@@ -43,7 +43,7 @@ import { computeRouteDistance } from './route-distance.js';
  * import { createFlightplanResolver, computeRouteTiming } from '@squawk/flightplan';
  *
  * const resolver = createFlightplanResolver({ airports, navaids, fixes, airways });
- * const route = resolver.parse('KJFK DCT MERIT J60 MARTN DCT KLAX');
+ * const route = resolver.parse('KLAX DCT LAX J60 SAX DCT KJFK');
  * const result = computeRouteTiming(route, {
  *   trueAirspeedKt: 450,
  *   windProvider: (lat, lon) => ({ directionDeg: 270, speedKt: 80 }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squawk/flightplan",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "type": "module",
   "description": "Flight plan route string parsing and resolution using composed navigation resolvers",
   "author": "Neil Cochran",
@@ -50,8 +50,8 @@
   "devDependencies": {
     "@squawk/airport-data": "^0.8.2",
     "@squawk/airports": "^0.7.3",
-    "@squawk/airway-data": "^0.6.2",
-    "@squawk/airways": "^0.5.2",
+    "@squawk/airway-data": "^0.6.3",
+    "@squawk/airways": "^0.5.3",
     "@squawk/fix-data": "^0.7.2",
     "@squawk/fixes": "^0.5.3",
     "@squawk/navaid-data": "^0.7.2",