@rise-maritime/keelson-js 0.6.0-alpha.275.dev.1 → 0.6.0-alpha.275.dev.2

package/dist/interfaces/Route.d.ts

@@ -100,23 +100,26 @@ export declare enum GeometryType {
 export declare function geometryTypeFromJSON(object: any): GeometryType;
 export declare function geometryTypeToJSON(object: GeometryType): string;
 /**
- * How a leg's XTD corridor boundary is defined. UNSPECIFIED MUST be read as
- * OFFSET: every leg published before this field existed is a constant-offset
- * corridor, and reading it any other way would change routes nobody edited.
+ * How a leg's XTD corridor is shaped. UNSPECIFIED MUST be read as FIXED:
+ * every leg published before this field existed is a fixed-width corridor, and
+ * reading it any other way would change routes nobody edited.
  */
 export declare enum XtdCorridorMode {
     XTD_CORRIDOR_MODE_UNSPECIFIED = 0,
-    /** XTD_CORRIDOR_MODE_OFFSET - Parallel lines at xtd_port_m / xtd_starboard_m either side of track. */
-    XTD_CORRIDOR_MODE_OFFSET = 1,
     /**
-     * XTD_CORRIDOR_MODE_POLYLINE - A boundary drawn by the planner (Leg.xtd_port_boundary /
+     * XTD_CORRIDOR_MODE_FIXED - Fixed width: parallel lines at xtd_port_m / xtd_starboard_m either side of
+     * track.
+     */
+    XTD_CORRIDOR_MODE_FIXED = 1,
+    /**
+     * XTD_CORRIDOR_MODE_VARIABLE - Variable width: a boundary drawn by the planner (Leg.xtd_port_boundary /
      * xtd_starboard_boundary), e.g. a corridor that narrows past a shoal.
      * xtd_port_m / xtd_starboard_m still carry a nominal limit for a monitor
-     * that does not evaluate polylines. That fallback is NOT conservative when
+     * that does not evaluate the boundary. That fallback is NOT conservative when
      * the drawn corridor is narrower than the nominal one, which is why such a
      * monitor SHOULD report the leg as monitored at reduced fidelity.
      */
-    XTD_CORRIDOR_MODE_POLYLINE = 2,
+    XTD_CORRIDOR_MODE_VARIABLE = 2,
     UNRECOGNIZED = -1
 }
 export declare function xtdCorridorModeFromJSON(object: any): XtdCorridorMode;
@@ -489,15 +492,15 @@ export interface Leg {
     xtdMonitoringPortM?: number | undefined;
     xtdMonitoringStarboardM?: number | undefined;
     /**
-     * How this leg's XTD corridor boundary is shaped. See XtdCorridorMode and
+     * Whether this leg's XTD corridor is fixed or variable width. See XtdCorridorMode and
      * protocol-specification.md §6.2.2.
      */
     xtdCorridorMode: XtdCorridorMode;
     /**
-     * POLYLINE only: the drawn corridor boundary on each side, vertices in
+     * VARIABLE only: the drawn corridor boundary on each side, vertices in
      * along-track order, covering this leg and the turn at the waypoint it
-     * arrives at. A consumer MUST ignore both lists unless the mode is POLYLINE,
-     * so a stale shape left behind by a switch back to OFFSET is never sailed.
+     * arrives at. A consumer MUST ignore both lists unless the mode is VARIABLE,
+     * so a stale shape left behind by a switch back to FIXED is never sailed.
      */
     xtdPortBoundary: XtdBoundaryPoint[];
     xtdStarboardBoundary: XtdBoundaryPoint[];
@@ -550,7 +553,7 @@ export interface Leg {
     extensions: Extensions | undefined;
 }
 /**
- * One vertex of a drawn XTD corridor boundary (Leg.xtd_port_boundary /
+ * One vertex of a variable-width XTD corridor boundary (Leg.xtd_port_boundary /
  * Leg.xtd_starboard_boundary).
  */
 export interface XtdBoundaryPoint {

package/dist/interfaces/Route.js

@@ -433,24 +433,27 @@ function geometryTypeToJSON(object) {
 }
 exports.geometryTypeToJSON = geometryTypeToJSON;
 /**
- * How a leg's XTD corridor boundary is defined. UNSPECIFIED MUST be read as
- * OFFSET: every leg published before this field existed is a constant-offset
- * corridor, and reading it any other way would change routes nobody edited.
+ * How a leg's XTD corridor is shaped. UNSPECIFIED MUST be read as FIXED:
+ * every leg published before this field existed is a fixed-width corridor, and
+ * reading it any other way would change routes nobody edited.
  */
 var XtdCorridorMode;
 (function (XtdCorridorMode) {
     XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_UNSPECIFIED"] = 0] = "XTD_CORRIDOR_MODE_UNSPECIFIED";
-    /** XTD_CORRIDOR_MODE_OFFSET - Parallel lines at xtd_port_m / xtd_starboard_m either side of track. */
-    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_OFFSET"] = 1] = "XTD_CORRIDOR_MODE_OFFSET";
     /**
-     * XTD_CORRIDOR_MODE_POLYLINE - A boundary drawn by the planner (Leg.xtd_port_boundary /
+     * XTD_CORRIDOR_MODE_FIXED - Fixed width: parallel lines at xtd_port_m / xtd_starboard_m either side of
+     * track.
+     */
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_FIXED"] = 1] = "XTD_CORRIDOR_MODE_FIXED";
+    /**
+     * XTD_CORRIDOR_MODE_VARIABLE - Variable width: a boundary drawn by the planner (Leg.xtd_port_boundary /
      * xtd_starboard_boundary), e.g. a corridor that narrows past a shoal.
      * xtd_port_m / xtd_starboard_m still carry a nominal limit for a monitor
-     * that does not evaluate polylines. That fallback is NOT conservative when
+     * that does not evaluate the boundary. That fallback is NOT conservative when
      * the drawn corridor is narrower than the nominal one, which is why such a
      * monitor SHOULD report the leg as monitored at reduced fidelity.
      */
-    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_POLYLINE"] = 2] = "XTD_CORRIDOR_MODE_POLYLINE";
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_VARIABLE"] = 2] = "XTD_CORRIDOR_MODE_VARIABLE";
     XtdCorridorMode[XtdCorridorMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(XtdCorridorMode || (exports.XtdCorridorMode = XtdCorridorMode = {}));
 function xtdCorridorModeFromJSON(object) {
@@ -459,11 +462,11 @@ function xtdCorridorModeFromJSON(object) {
         case "XTD_CORRIDOR_MODE_UNSPECIFIED":
             return XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED;
         case 1:
-        case "XTD_CORRIDOR_MODE_OFFSET":
-            return XtdCorridorMode.XTD_CORRIDOR_MODE_OFFSET;
+        case "XTD_CORRIDOR_MODE_FIXED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED;
         case 2:
-        case "XTD_CORRIDOR_MODE_POLYLINE":
-            return XtdCorridorMode.XTD_CORRIDOR_MODE_POLYLINE;
+        case "XTD_CORRIDOR_MODE_VARIABLE":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE;
         case -1:
         case "UNRECOGNIZED":
         default:
@@ -475,10 +478,10 @@ function xtdCorridorModeToJSON(object) {
     switch (object) {
         case XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED:
             return "XTD_CORRIDOR_MODE_UNSPECIFIED";
-        case XtdCorridorMode.XTD_CORRIDOR_MODE_OFFSET:
-            return "XTD_CORRIDOR_MODE_OFFSET";
-        case XtdCorridorMode.XTD_CORRIDOR_MODE_POLYLINE:
-            return "XTD_CORRIDOR_MODE_POLYLINE";
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED:
+            return "XTD_CORRIDOR_MODE_FIXED";
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE:
+            return "XTD_CORRIDOR_MODE_VARIABLE";
         case XtdCorridorMode.UNRECOGNIZED:
         default:
             return "UNRECOGNIZED";

package/dist/payloads/Route.d.ts

@@ -99,23 +99,26 @@ export declare enum GeometryType {
 export declare function geometryTypeFromJSON(object: any): GeometryType;
 export declare function geometryTypeToJSON(object: GeometryType): string;
 /**
- * How a leg's XTD corridor boundary is defined. UNSPECIFIED MUST be read as
- * OFFSET: every leg published before this field existed is a constant-offset
- * corridor, and reading it any other way would change routes nobody edited.
+ * How a leg's XTD corridor is shaped. UNSPECIFIED MUST be read as FIXED:
+ * every leg published before this field existed is a fixed-width corridor, and
+ * reading it any other way would change routes nobody edited.
  */
 export declare enum XtdCorridorMode {
     XTD_CORRIDOR_MODE_UNSPECIFIED = 0,
-    /** XTD_CORRIDOR_MODE_OFFSET - Parallel lines at xtd_port_m / xtd_starboard_m either side of track. */
-    XTD_CORRIDOR_MODE_OFFSET = 1,
     /**
-     * XTD_CORRIDOR_MODE_POLYLINE - A boundary drawn by the planner (Leg.xtd_port_boundary /
+     * XTD_CORRIDOR_MODE_FIXED - Fixed width: parallel lines at xtd_port_m / xtd_starboard_m either side of
+     * track.
+     */
+    XTD_CORRIDOR_MODE_FIXED = 1,
+    /**
+     * XTD_CORRIDOR_MODE_VARIABLE - Variable width: a boundary drawn by the planner (Leg.xtd_port_boundary /
      * xtd_starboard_boundary), e.g. a corridor that narrows past a shoal.
      * xtd_port_m / xtd_starboard_m still carry a nominal limit for a monitor
-     * that does not evaluate polylines. That fallback is NOT conservative when
+     * that does not evaluate the boundary. That fallback is NOT conservative when
      * the drawn corridor is narrower than the nominal one, which is why such a
      * monitor SHOULD report the leg as monitored at reduced fidelity.
      */
-    XTD_CORRIDOR_MODE_POLYLINE = 2,
+    XTD_CORRIDOR_MODE_VARIABLE = 2,
     UNRECOGNIZED = -1
 }
 export declare function xtdCorridorModeFromJSON(object: any): XtdCorridorMode;
@@ -499,15 +502,15 @@ export interface Leg {
     xtdMonitoringPortM?: number | undefined;
     xtdMonitoringStarboardM?: number | undefined;
     /**
-     * How this leg's XTD corridor boundary is shaped. See XtdCorridorMode and
+     * Whether this leg's XTD corridor is fixed or variable width. See XtdCorridorMode and
      * protocol-specification.md §6.2.2.
      */
     xtdCorridorMode: XtdCorridorMode;
     /**
-     * POLYLINE only: the drawn corridor boundary on each side, vertices in
+     * VARIABLE only: the drawn corridor boundary on each side, vertices in
      * along-track order, covering this leg and the turn at the waypoint it
-     * arrives at. A consumer MUST ignore both lists unless the mode is POLYLINE,
-     * so a stale shape left behind by a switch back to OFFSET is never sailed.
+     * arrives at. A consumer MUST ignore both lists unless the mode is VARIABLE,
+     * so a stale shape left behind by a switch back to FIXED is never sailed.
      */
     xtdPortBoundary: XtdBoundaryPoint[];
     xtdStarboardBoundary: XtdBoundaryPoint[];
@@ -560,7 +563,7 @@ export interface Leg {
     extensions: Extensions | undefined;
 }
 /**
- * One vertex of a drawn XTD corridor boundary (Leg.xtd_port_boundary /
+ * One vertex of a variable-width XTD corridor boundary (Leg.xtd_port_boundary /
  * Leg.xtd_starboard_boundary).
  */
 export interface XtdBoundaryPoint {

package/dist/payloads/Route.js

@@ -433,24 +433,27 @@ function geometryTypeToJSON(object) {
 }
 exports.geometryTypeToJSON = geometryTypeToJSON;
 /**
- * How a leg's XTD corridor boundary is defined. UNSPECIFIED MUST be read as
- * OFFSET: every leg published before this field existed is a constant-offset
- * corridor, and reading it any other way would change routes nobody edited.
+ * How a leg's XTD corridor is shaped. UNSPECIFIED MUST be read as FIXED:
+ * every leg published before this field existed is a fixed-width corridor, and
+ * reading it any other way would change routes nobody edited.
  */
 var XtdCorridorMode;
 (function (XtdCorridorMode) {
     XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_UNSPECIFIED"] = 0] = "XTD_CORRIDOR_MODE_UNSPECIFIED";
-    /** XTD_CORRIDOR_MODE_OFFSET - Parallel lines at xtd_port_m / xtd_starboard_m either side of track. */
-    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_OFFSET"] = 1] = "XTD_CORRIDOR_MODE_OFFSET";
     /**
-     * XTD_CORRIDOR_MODE_POLYLINE - A boundary drawn by the planner (Leg.xtd_port_boundary /
+     * XTD_CORRIDOR_MODE_FIXED - Fixed width: parallel lines at xtd_port_m / xtd_starboard_m either side of
+     * track.
+     */
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_FIXED"] = 1] = "XTD_CORRIDOR_MODE_FIXED";
+    /**
+     * XTD_CORRIDOR_MODE_VARIABLE - Variable width: a boundary drawn by the planner (Leg.xtd_port_boundary /
      * xtd_starboard_boundary), e.g. a corridor that narrows past a shoal.
      * xtd_port_m / xtd_starboard_m still carry a nominal limit for a monitor
-     * that does not evaluate polylines. That fallback is NOT conservative when
+     * that does not evaluate the boundary. That fallback is NOT conservative when
      * the drawn corridor is narrower than the nominal one, which is why such a
      * monitor SHOULD report the leg as monitored at reduced fidelity.
      */
-    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_POLYLINE"] = 2] = "XTD_CORRIDOR_MODE_POLYLINE";
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_VARIABLE"] = 2] = "XTD_CORRIDOR_MODE_VARIABLE";
     XtdCorridorMode[XtdCorridorMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(XtdCorridorMode || (exports.XtdCorridorMode = XtdCorridorMode = {}));
 function xtdCorridorModeFromJSON(object) {
@@ -459,11 +462,11 @@ function xtdCorridorModeFromJSON(object) {
         case "XTD_CORRIDOR_MODE_UNSPECIFIED":
             return XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED;
         case 1:
-        case "XTD_CORRIDOR_MODE_OFFSET":
-            return XtdCorridorMode.XTD_CORRIDOR_MODE_OFFSET;
+        case "XTD_CORRIDOR_MODE_FIXED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED;
         case 2:
-        case "XTD_CORRIDOR_MODE_POLYLINE":
-            return XtdCorridorMode.XTD_CORRIDOR_MODE_POLYLINE;
+        case "XTD_CORRIDOR_MODE_VARIABLE":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE;
         case -1:
         case "UNRECOGNIZED":
         default:
@@ -475,10 +478,10 @@ function xtdCorridorModeToJSON(object) {
     switch (object) {
         case XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED:
             return "XTD_CORRIDOR_MODE_UNSPECIFIED";
-        case XtdCorridorMode.XTD_CORRIDOR_MODE_OFFSET:
-            return "XTD_CORRIDOR_MODE_OFFSET";
-        case XtdCorridorMode.XTD_CORRIDOR_MODE_POLYLINE:
-            return "XTD_CORRIDOR_MODE_POLYLINE";
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED:
+            return "XTD_CORRIDOR_MODE_FIXED";
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE:
+            return "XTD_CORRIDOR_MODE_VARIABLE";
         case XtdCorridorMode.UNRECOGNIZED:
         default:
             return "UNRECOGNIZED";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rise-maritime/keelson-js",
   "//version": "NOT the published version. The release workflow overwrites it from the release tag (npm version --no-git-tag-version), so tag and artifact cannot disagree. Only matters for local installs; do not hand-bump before tagging — that manual step is what broke release 0.5.4.",
-  "version": "0.6.0-alpha.275.dev.1",
+  "version": "0.6.0-alpha.275.dev.2",
   "description": "Keelson JavaScript SDK with Node-RED nodes",
   "main": "dist/index.js",
   "files": [