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

package/dist/interfaces/Route.d.ts

@@ -99,6 +99,34 @@ export declare enum GeometryType {
 }
 export declare function geometryTypeFromJSON(object: any): GeometryType;
 export declare function geometryTypeToJSON(object: GeometryType): string;
+/**
+ * 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_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.
+     * The metre fields (xtd_port_m / xtd_starboard_m and the monitoring pair)
+     * MUST NOT exceed the closest approach to track of that side's drawn
+     * boundary: they are the INSCRIBED fixed corridor. A monitor that does not
+     * evaluate the boundary then alarms early on a wide stretch and never late at
+     * the narrow one, which is the direction an XTD limit has to fail. Such a
+     * monitor SHOULD report the leg as monitored at reduced fidelity, which is
+     * why its alarm may come early.
+     */
+    XTD_CORRIDOR_MODE_VARIABLE = 2,
+    UNRECOGNIZED = -1
+}
+export declare function xtdCorridorModeFromJSON(object: any): XtdCorridorMode;
+export declare function xtdCorridorModeToJSON(object: XtdCorridorMode): string;
 /**
  * Whether a route's waypoint list closes back on itself. RTZ 1.2 has no such
  * concept, so producers either repeated the first waypoint (breaking id
@@ -460,12 +488,29 @@ export interface Leg {
     /**
      * Cross-track distance (XTD) limits and monitoring thresholds, in metres.
      * `optional` so producers can distinguish "no XTD limit" (unset) from
-     * "zero XTD limit" (set to 0).
+     * "zero XTD limit" (set to 0). Under XTD_CORRIDOR_MODE_VARIABLE all four are
+     * the inscribed corridor (protocol-specification.md §6.2.2).
      */
     xtdPortM?: number | undefined;
     xtdStarboardM?: number | undefined;
     xtdMonitoringPortM?: number | undefined;
     xtdMonitoringStarboardM?: number | undefined;
+    /**
+     * Whether this leg's XTD corridor is fixed or variable width. See XtdCorridorMode and
+     * protocol-specification.md §6.2.2.
+     */
+    xtdCorridorMode: XtdCorridorMode;
+    /**
+     * 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 VARIABLE,
+     * so a stale shape left behind by a switch back to FIXED is never sailed.
+     * Where the next leg is VARIABLE too, the last vertex on a side SHOULD
+     * coincide with the first vertex of waypoint[i+1].leg's list on that side, so
+     * a monitor meets neither a gap nor an overlap at the junction.
+     */
+    xtdPortBoundary: XtdBoundaryPoint[];
+    xtdStarboardBoundary: XtdBoundaryPoint[];
     /**
      * Safety contour (depth in metres below chart datum) below which the route
      * is considered unsafe.
@@ -514,6 +559,36 @@ export interface Leg {
     colregTrafficIntensity: ColregTrafficIntensity;
     extensions: Extensions | undefined;
 }
+/**
+ * One vertex of a variable-width XTD corridor boundary (Leg.xtd_port_boundary /
+ * Leg.xtd_starboard_boundary).
+ */
+export interface XtdBoundaryPoint {
+    /**
+     * WGS-84 vertex. Authoritative: this is the boundary a monitor checks
+     * against, whatever the anchor below says.
+     */
+    position: Coordinate | undefined;
+    /**
+     * Editor anchor — where along the leg's straight the vertex was placed,
+     * 0 at the leg's start and 1 at its end, and how far off track. Lets an
+     * editor keep the vertex attached to the leg when a waypoint moves, instead
+     * of leaving it stranded at its old position. `optional` because a vertex
+     * placed freely (at a leg end or inside a turn) has no such anchor, and 0
+     * is a real fraction.
+     */
+    alongTrackFraction?: number | undefined;
+    /**
+     * Perpendicular distance from track for that anchor, metres, always
+     * positive: the side is given by which boundary list holds the vertex.
+     */
+    offsetM?: number | undefined;
+    /**
+     * True when the vertex lies on the turn at the leg's end rather than on the
+     * straight.
+     */
+    inTurn: boolean;
+}
 export interface Schedules {
     /** Multiple schedules can coexist (e.g. "manual", "weather-optimized"). */
     schedule: Schedule[];
@@ -698,6 +773,7 @@ export declare const Waypoints: MessageFns<Waypoints>;
 export declare const DefaultWaypoint: MessageFns<DefaultWaypoint>;
 export declare const Waypoint: MessageFns<Waypoint>;
 export declare const Leg: MessageFns<Leg>;
+export declare const XtdBoundaryPoint: MessageFns<XtdBoundaryPoint>;
 export declare const Schedules: MessageFns<Schedules>;
 export declare const Schedule: MessageFns<Schedule>;
 export declare const ScheduleElement: MessageFns<ScheduleElement>;

package/dist/interfaces/Route.js

@@ -5,8 +5,8 @@
 //   protoc               v6.30.2
 // source: Route.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schedule = exports.Schedules = exports.Leg = exports.Waypoint = exports.DefaultWaypoint = exports.Waypoints = exports.RouteInfo = exports.Route = exports.Extensions_Entry_AttributesEntry = exports.Extensions_Entry = exports.Extensions = exports.CircleGeometry = exports.RouteRef = exports.schedule_OriginToJSON = exports.schedule_OriginFromJSON = exports.Schedule_Origin = exports.actionPointRequiredActionToJSON = exports.actionPointRequiredActionFromJSON = exports.ActionPointRequiredAction = exports.envelopeBoundToJSON = exports.envelopeBoundFromJSON = exports.EnvelopeBound = exports.routeStatusToJSON = exports.routeStatusFromJSON = exports.RouteStatus = exports.routeTopologyToJSON = exports.routeTopologyFromJSON = exports.RouteTopology = exports.geometryTypeToJSON = exports.geometryTypeFromJSON = exports.GeometryType = exports.colregTrafficIntensityToJSON = exports.colregTrafficIntensityFromJSON = exports.ColregTrafficIntensity = exports.colregSituationToJSON = exports.colregSituationFromJSON = exports.ColregSituation = exports.hazardZoneTypeToJSON = exports.hazardZoneTypeFromJSON = exports.HazardZoneType = exports.routeChallengeTypeToJSON = exports.routeChallengeTypeFromJSON = exports.RouteChallengeType = exports.operationalContextToJSON = exports.operationalContextFromJSON = exports.OperationalContext = exports.autonomyLevelToJSON = exports.autonomyLevelFromJSON = exports.AutonomyLevel = exports.protobufPackage = void 0;
-exports.RouteStatusUpdate = exports.RouteSignature = exports.RouteSignatures = exports.RouteIssue = exports.RouteChallenge = exports.HazardZone = exports.ActionPoint = exports.ActionPoints = exports.ScheduleElement = void 0;
+exports.Waypoint = exports.DefaultWaypoint = exports.Waypoints = exports.RouteInfo = exports.Route = exports.Extensions_Entry_AttributesEntry = exports.Extensions_Entry = exports.Extensions = exports.CircleGeometry = exports.RouteRef = exports.schedule_OriginToJSON = exports.schedule_OriginFromJSON = exports.Schedule_Origin = exports.actionPointRequiredActionToJSON = exports.actionPointRequiredActionFromJSON = exports.ActionPointRequiredAction = exports.envelopeBoundToJSON = exports.envelopeBoundFromJSON = exports.EnvelopeBound = exports.routeStatusToJSON = exports.routeStatusFromJSON = exports.RouteStatus = exports.routeTopologyToJSON = exports.routeTopologyFromJSON = exports.RouteTopology = exports.xtdCorridorModeToJSON = exports.xtdCorridorModeFromJSON = exports.XtdCorridorMode = exports.geometryTypeToJSON = exports.geometryTypeFromJSON = exports.GeometryType = exports.colregTrafficIntensityToJSON = exports.colregTrafficIntensityFromJSON = exports.ColregTrafficIntensity = exports.colregSituationToJSON = exports.colregSituationFromJSON = exports.ColregSituation = exports.hazardZoneTypeToJSON = exports.hazardZoneTypeFromJSON = exports.HazardZoneType = exports.routeChallengeTypeToJSON = exports.routeChallengeTypeFromJSON = exports.RouteChallengeType = exports.operationalContextToJSON = exports.operationalContextFromJSON = exports.OperationalContext = exports.autonomyLevelToJSON = exports.autonomyLevelFromJSON = exports.AutonomyLevel = exports.protobufPackage = void 0;
+exports.RouteStatusUpdate = exports.RouteSignature = exports.RouteSignatures = exports.RouteIssue = exports.RouteChallenge = exports.HazardZone = exports.ActionPoint = exports.ActionPoints = exports.ScheduleElement = exports.Schedule = exports.Schedules = exports.XtdBoundaryPoint = exports.Leg = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const Coordinate_1 = require("./Coordinate");
@@ -432,6 +432,65 @@ function geometryTypeToJSON(object) {
     }
 }
 exports.geometryTypeToJSON = geometryTypeToJSON;
+/**
+ * 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_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.
+     * The metre fields (xtd_port_m / xtd_starboard_m and the monitoring pair)
+     * MUST NOT exceed the closest approach to track of that side's drawn
+     * boundary: they are the INSCRIBED fixed corridor. A monitor that does not
+     * evaluate the boundary then alarms early on a wide stretch and never late at
+     * the narrow one, which is the direction an XTD limit has to fail. Such a
+     * monitor SHOULD report the leg as monitored at reduced fidelity, which is
+     * why its alarm may come early.
+     */
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_VARIABLE"] = 2] = "XTD_CORRIDOR_MODE_VARIABLE";
+    XtdCorridorMode[XtdCorridorMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(XtdCorridorMode || (exports.XtdCorridorMode = XtdCorridorMode = {}));
+function xtdCorridorModeFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "XTD_CORRIDOR_MODE_UNSPECIFIED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED;
+        case 1:
+        case "XTD_CORRIDOR_MODE_FIXED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED;
+        case 2:
+        case "XTD_CORRIDOR_MODE_VARIABLE":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return XtdCorridorMode.UNRECOGNIZED;
+    }
+}
+exports.xtdCorridorModeFromJSON = xtdCorridorModeFromJSON;
+function xtdCorridorModeToJSON(object) {
+    switch (object) {
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED:
+            return "XTD_CORRIDOR_MODE_UNSPECIFIED";
+        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";
+    }
+}
+exports.xtdCorridorModeToJSON = xtdCorridorModeToJSON;
 /**
  * Whether a route's waypoint list closes back on itself. RTZ 1.2 has no such
  * concept, so producers either repeated the first waypoint (breaking id
@@ -2219,6 +2278,9 @@ function createBaseLeg() {
         xtdStarboardM: undefined,
         xtdMonitoringPortM: undefined,
         xtdMonitoringStarboardM: undefined,
+        xtdCorridorMode: 0,
+        xtdPortBoundary: [],
+        xtdStarboardBoundary: [],
         safetyContourM: undefined,
         safetyDepthM: undefined,
         ukcStaticM: undefined,
@@ -2256,6 +2318,15 @@ exports.Leg = {
         if (message.xtdMonitoringStarboardM !== undefined) {
             writer.uint32(37).float(message.xtdMonitoringStarboardM);
         }
+        if (message.xtdCorridorMode !== 0) {
+            writer.uint32(40).int32(message.xtdCorridorMode);
+        }
+        for (const v of message.xtdPortBoundary) {
+            exports.XtdBoundaryPoint.encode(v, writer.uint32(50).fork()).join();
+        }
+        for (const v of message.xtdStarboardBoundary) {
+            exports.XtdBoundaryPoint.encode(v, writer.uint32(58).fork()).join();
+        }
         if (message.safetyContourM !== undefined) {
             writer.uint32(85).float(message.safetyContourM);
         }
@@ -2356,6 +2427,27 @@ exports.Leg = {
                     message.xtdMonitoringStarboardM = reader.float();
                     continue;
                 }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.xtdCorridorMode = reader.int32();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.xtdPortBoundary.push(exports.XtdBoundaryPoint.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.xtdStarboardBoundary.push(exports.XtdBoundaryPoint.decode(reader, reader.uint32()));
+                    continue;
+                }
                 case 10: {
                     if (tag !== 85) {
                         break;
@@ -2519,6 +2611,13 @@ exports.Leg = {
             xtdMonitoringStarboardM: isSet(object.xtdMonitoringStarboardM)
                 ? globalThis.Number(object.xtdMonitoringStarboardM)
                 : undefined,
+            xtdCorridorMode: isSet(object.xtdCorridorMode) ? xtdCorridorModeFromJSON(object.xtdCorridorMode) : 0,
+            xtdPortBoundary: globalThis.Array.isArray(object?.xtdPortBoundary)
+                ? object.xtdPortBoundary.map((e) => exports.XtdBoundaryPoint.fromJSON(e))
+                : [],
+            xtdStarboardBoundary: globalThis.Array.isArray(object?.xtdStarboardBoundary)
+                ? object.xtdStarboardBoundary.map((e) => exports.XtdBoundaryPoint.fromJSON(e))
+                : [],
             safetyContourM: isSet(object.safetyContourM) ? globalThis.Number(object.safetyContourM) : undefined,
             safetyDepthM: isSet(object.safetyDepthM) ? globalThis.Number(object.safetyDepthM) : undefined,
             ukcStaticM: isSet(object.ukcStaticM) ? globalThis.Number(object.ukcStaticM) : undefined,
@@ -2558,6 +2657,15 @@ exports.Leg = {
         if (message.xtdMonitoringStarboardM !== undefined) {
             obj.xtdMonitoringStarboardM = message.xtdMonitoringStarboardM;
         }
+        if (message.xtdCorridorMode !== 0) {
+            obj.xtdCorridorMode = xtdCorridorModeToJSON(message.xtdCorridorMode);
+        }
+        if (message.xtdPortBoundary?.length) {
+            obj.xtdPortBoundary = message.xtdPortBoundary.map((e) => exports.XtdBoundaryPoint.toJSON(e));
+        }
+        if (message.xtdStarboardBoundary?.length) {
+            obj.xtdStarboardBoundary = message.xtdStarboardBoundary.map((e) => exports.XtdBoundaryPoint.toJSON(e));
+        }
         if (message.safetyContourM !== undefined) {
             obj.safetyContourM = message.safetyContourM;
         }
@@ -2632,6 +2740,9 @@ exports.Leg = {
         message.xtdStarboardM = object.xtdStarboardM ?? undefined;
         message.xtdMonitoringPortM = object.xtdMonitoringPortM ?? undefined;
         message.xtdMonitoringStarboardM = object.xtdMonitoringStarboardM ?? undefined;
+        message.xtdCorridorMode = object.xtdCorridorMode ?? 0;
+        message.xtdPortBoundary = object.xtdPortBoundary?.map((e) => exports.XtdBoundaryPoint.fromPartial(e)) || [];
+        message.xtdStarboardBoundary = object.xtdStarboardBoundary?.map((e) => exports.XtdBoundaryPoint.fromPartial(e)) || [];
         message.safetyContourM = object.safetyContourM ?? undefined;
         message.safetyDepthM = object.safetyDepthM ?? undefined;
         message.ukcStaticM = object.ukcStaticM ?? undefined;
@@ -2658,6 +2769,106 @@ exports.Leg = {
         return message;
     },
 };
+function createBaseXtdBoundaryPoint() {
+    return { position: undefined, alongTrackFraction: undefined, offsetM: undefined, inTurn: false };
+}
+exports.XtdBoundaryPoint = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.position !== undefined) {
+            Coordinate_1.Coordinate.encode(message.position, writer.uint32(10).fork()).join();
+        }
+        if (message.alongTrackFraction !== undefined) {
+            writer.uint32(17).double(message.alongTrackFraction);
+        }
+        if (message.offsetM !== undefined) {
+            writer.uint32(29).float(message.offsetM);
+        }
+        if (message.inTurn !== false) {
+            writer.uint32(32).bool(message.inTurn);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseXtdBoundaryPoint();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.position = Coordinate_1.Coordinate.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 17) {
+                        break;
+                    }
+                    message.alongTrackFraction = reader.double();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 29) {
+                        break;
+                    }
+                    message.offsetM = reader.float();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.inTurn = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            position: isSet(object.position) ? Coordinate_1.Coordinate.fromJSON(object.position) : undefined,
+            alongTrackFraction: isSet(object.alongTrackFraction) ? globalThis.Number(object.alongTrackFraction) : undefined,
+            offsetM: isSet(object.offsetM) ? globalThis.Number(object.offsetM) : undefined,
+            inTurn: isSet(object.inTurn) ? globalThis.Boolean(object.inTurn) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.position !== undefined) {
+            obj.position = Coordinate_1.Coordinate.toJSON(message.position);
+        }
+        if (message.alongTrackFraction !== undefined) {
+            obj.alongTrackFraction = message.alongTrackFraction;
+        }
+        if (message.offsetM !== undefined) {
+            obj.offsetM = message.offsetM;
+        }
+        if (message.inTurn !== false) {
+            obj.inTurn = message.inTurn;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.XtdBoundaryPoint.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseXtdBoundaryPoint();
+        message.position = (object.position !== undefined && object.position !== null)
+            ? Coordinate_1.Coordinate.fromPartial(object.position)
+            : undefined;
+        message.alongTrackFraction = object.alongTrackFraction ?? undefined;
+        message.offsetM = object.offsetM ?? undefined;
+        message.inTurn = object.inTurn ?? false;
+        return message;
+    },
+};
 function createBaseSchedules() {
     return { schedule: [], extensions: undefined };
 }

package/dist/payloads/Route.d.ts

@@ -98,6 +98,34 @@ export declare enum GeometryType {
 }
 export declare function geometryTypeFromJSON(object: any): GeometryType;
 export declare function geometryTypeToJSON(object: GeometryType): string;
+/**
+ * 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_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.
+     * The metre fields (xtd_port_m / xtd_starboard_m and the monitoring pair)
+     * MUST NOT exceed the closest approach to track of that side's drawn
+     * boundary: they are the INSCRIBED fixed corridor. A monitor that does not
+     * evaluate the boundary then alarms early on a wide stretch and never late at
+     * the narrow one, which is the direction an XTD limit has to fail. Such a
+     * monitor SHOULD report the leg as monitored at reduced fidelity, which is
+     * why its alarm may come early.
+     */
+    XTD_CORRIDOR_MODE_VARIABLE = 2,
+    UNRECOGNIZED = -1
+}
+export declare function xtdCorridorModeFromJSON(object: any): XtdCorridorMode;
+export declare function xtdCorridorModeToJSON(object: XtdCorridorMode): string;
 /**
  * Whether a route's waypoint list closes back on itself. RTZ 1.2 has no such
  * concept, so producers either repeated the first waypoint (breaking id
@@ -470,12 +498,29 @@ export interface Leg {
     /**
      * Cross-track distance (XTD) limits and monitoring thresholds, in metres.
      * `optional` so producers can distinguish "no XTD limit" (unset) from
-     * "zero XTD limit" (set to 0).
+     * "zero XTD limit" (set to 0). Under XTD_CORRIDOR_MODE_VARIABLE all four are
+     * the inscribed corridor (protocol-specification.md §6.2.2).
      */
     xtdPortM?: number | undefined;
     xtdStarboardM?: number | undefined;
     xtdMonitoringPortM?: number | undefined;
     xtdMonitoringStarboardM?: number | undefined;
+    /**
+     * Whether this leg's XTD corridor is fixed or variable width. See XtdCorridorMode and
+     * protocol-specification.md §6.2.2.
+     */
+    xtdCorridorMode: XtdCorridorMode;
+    /**
+     * 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 VARIABLE,
+     * so a stale shape left behind by a switch back to FIXED is never sailed.
+     * Where the next leg is VARIABLE too, the last vertex on a side SHOULD
+     * coincide with the first vertex of waypoint[i+1].leg's list on that side, so
+     * a monitor meets neither a gap nor an overlap at the junction.
+     */
+    xtdPortBoundary: XtdBoundaryPoint[];
+    xtdStarboardBoundary: XtdBoundaryPoint[];
     /**
      * Safety contour (depth in metres below chart datum) below which the route
      * is considered unsafe.
@@ -524,6 +569,37 @@ export interface Leg {
     colregTrafficIntensity: ColregTrafficIntensity;
     extensions: Extensions | undefined;
 }
+/**
+ * One vertex of a variable-width XTD corridor boundary (Leg.xtd_port_boundary /
+ * Leg.xtd_starboard_boundary).
+ */
+export interface XtdBoundaryPoint {
+    $type: "keelson.XtdBoundaryPoint";
+    /**
+     * WGS-84 vertex. Authoritative: this is the boundary a monitor checks
+     * against, whatever the anchor below says.
+     */
+    position: Coordinate | undefined;
+    /**
+     * Editor anchor — where along the leg's straight the vertex was placed,
+     * 0 at the leg's start and 1 at its end, and how far off track. Lets an
+     * editor keep the vertex attached to the leg when a waypoint moves, instead
+     * of leaving it stranded at its old position. `optional` because a vertex
+     * placed freely (at a leg end or inside a turn) has no such anchor, and 0
+     * is a real fraction.
+     */
+    alongTrackFraction?: number | undefined;
+    /**
+     * Perpendicular distance from track for that anchor, metres, always
+     * positive: the side is given by which boundary list holds the vertex.
+     */
+    offsetM?: number | undefined;
+    /**
+     * True when the vertex lies on the turn at the leg's end rather than on the
+     * straight.
+     */
+    inTurn: boolean;
+}
 export interface Schedules {
     $type: "keelson.Schedules";
     /** Multiple schedules can coexist (e.g. "manual", "weather-optimized"). */
@@ -719,6 +795,7 @@ export declare const Waypoints: MessageFns<Waypoints, "keelson.Waypoints">;
 export declare const DefaultWaypoint: MessageFns<DefaultWaypoint, "keelson.DefaultWaypoint">;
 export declare const Waypoint: MessageFns<Waypoint, "keelson.Waypoint">;
 export declare const Leg: MessageFns<Leg, "keelson.Leg">;
+export declare const XtdBoundaryPoint: MessageFns<XtdBoundaryPoint, "keelson.XtdBoundaryPoint">;
 export declare const Schedules: MessageFns<Schedules, "keelson.Schedules">;
 export declare const Schedule: MessageFns<Schedule, "keelson.Schedule">;
 export declare const ScheduleElement: MessageFns<ScheduleElement, "keelson.ScheduleElement">;

package/dist/payloads/Route.js

@@ -5,8 +5,8 @@
 //   protoc               v6.30.2
 // source: Route.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScheduleElement = exports.Schedule = exports.Schedules = exports.Leg = exports.Waypoint = exports.DefaultWaypoint = exports.Waypoints = exports.RouteInfo = exports.Route = exports.Extensions_Entry_AttributesEntry = exports.Extensions_Entry = exports.Extensions = exports.CircleGeometry = exports.RouteRef = exports.schedule_OriginToJSON = exports.schedule_OriginFromJSON = exports.Schedule_Origin = exports.actionPointRequiredActionToJSON = exports.actionPointRequiredActionFromJSON = exports.ActionPointRequiredAction = exports.envelopeBoundToJSON = exports.envelopeBoundFromJSON = exports.EnvelopeBound = exports.routeStatusToJSON = exports.routeStatusFromJSON = exports.RouteStatus = exports.routeTopologyToJSON = exports.routeTopologyFromJSON = exports.RouteTopology = exports.geometryTypeToJSON = exports.geometryTypeFromJSON = exports.GeometryType = exports.colregTrafficIntensityToJSON = exports.colregTrafficIntensityFromJSON = exports.ColregTrafficIntensity = exports.colregSituationToJSON = exports.colregSituationFromJSON = exports.ColregSituation = exports.hazardZoneTypeToJSON = exports.hazardZoneTypeFromJSON = exports.HazardZoneType = exports.routeChallengeTypeToJSON = exports.routeChallengeTypeFromJSON = exports.RouteChallengeType = exports.operationalContextToJSON = exports.operationalContextFromJSON = exports.OperationalContext = exports.autonomyLevelToJSON = exports.autonomyLevelFromJSON = exports.AutonomyLevel = void 0;
-exports.RouteStatusUpdate = exports.RouteSignature = exports.RouteSignatures = exports.RouteIssue = exports.RouteChallenge = exports.HazardZone = exports.ActionPoint = exports.ActionPoints = void 0;
+exports.Leg = exports.Waypoint = exports.DefaultWaypoint = exports.Waypoints = exports.RouteInfo = exports.Route = exports.Extensions_Entry_AttributesEntry = exports.Extensions_Entry = exports.Extensions = exports.CircleGeometry = exports.RouteRef = exports.schedule_OriginToJSON = exports.schedule_OriginFromJSON = exports.Schedule_Origin = exports.actionPointRequiredActionToJSON = exports.actionPointRequiredActionFromJSON = exports.ActionPointRequiredAction = exports.envelopeBoundToJSON = exports.envelopeBoundFromJSON = exports.EnvelopeBound = exports.routeStatusToJSON = exports.routeStatusFromJSON = exports.RouteStatus = exports.routeTopologyToJSON = exports.routeTopologyFromJSON = exports.RouteTopology = exports.xtdCorridorModeToJSON = exports.xtdCorridorModeFromJSON = exports.XtdCorridorMode = exports.geometryTypeToJSON = exports.geometryTypeFromJSON = exports.GeometryType = exports.colregTrafficIntensityToJSON = exports.colregTrafficIntensityFromJSON = exports.ColregTrafficIntensity = exports.colregSituationToJSON = exports.colregSituationFromJSON = exports.ColregSituation = exports.hazardZoneTypeToJSON = exports.hazardZoneTypeFromJSON = exports.HazardZoneType = exports.routeChallengeTypeToJSON = exports.routeChallengeTypeFromJSON = exports.RouteChallengeType = exports.operationalContextToJSON = exports.operationalContextFromJSON = exports.OperationalContext = exports.autonomyLevelToJSON = exports.autonomyLevelFromJSON = exports.AutonomyLevel = void 0;
+exports.RouteStatusUpdate = exports.RouteSignature = exports.RouteSignatures = exports.RouteIssue = exports.RouteChallenge = exports.HazardZone = exports.ActionPoint = exports.ActionPoints = exports.ScheduleElement = exports.Schedule = exports.Schedules = exports.XtdBoundaryPoint = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const Coordinate_1 = require("./Coordinate");
@@ -432,6 +432,65 @@ function geometryTypeToJSON(object) {
     }
 }
 exports.geometryTypeToJSON = geometryTypeToJSON;
+/**
+ * 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_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.
+     * The metre fields (xtd_port_m / xtd_starboard_m and the monitoring pair)
+     * MUST NOT exceed the closest approach to track of that side's drawn
+     * boundary: they are the INSCRIBED fixed corridor. A monitor that does not
+     * evaluate the boundary then alarms early on a wide stretch and never late at
+     * the narrow one, which is the direction an XTD limit has to fail. Such a
+     * monitor SHOULD report the leg as monitored at reduced fidelity, which is
+     * why its alarm may come early.
+     */
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_VARIABLE"] = 2] = "XTD_CORRIDOR_MODE_VARIABLE";
+    XtdCorridorMode[XtdCorridorMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(XtdCorridorMode || (exports.XtdCorridorMode = XtdCorridorMode = {}));
+function xtdCorridorModeFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "XTD_CORRIDOR_MODE_UNSPECIFIED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED;
+        case 1:
+        case "XTD_CORRIDOR_MODE_FIXED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED;
+        case 2:
+        case "XTD_CORRIDOR_MODE_VARIABLE":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return XtdCorridorMode.UNRECOGNIZED;
+    }
+}
+exports.xtdCorridorModeFromJSON = xtdCorridorModeFromJSON;
+function xtdCorridorModeToJSON(object) {
+    switch (object) {
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED:
+            return "XTD_CORRIDOR_MODE_UNSPECIFIED";
+        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";
+    }
+}
+exports.xtdCorridorModeToJSON = xtdCorridorModeToJSON;
 /**
  * Whether a route's waypoint list closes back on itself. RTZ 1.2 has no such
  * concept, so producers either repeated the first waypoint (breaking id
@@ -2264,6 +2323,9 @@ function createBaseLeg() {
         xtdStarboardM: undefined,
         xtdMonitoringPortM: undefined,
         xtdMonitoringStarboardM: undefined,
+        xtdCorridorMode: 0,
+        xtdPortBoundary: [],
+        xtdStarboardBoundary: [],
         safetyContourM: undefined,
         safetyDepthM: undefined,
         ukcStaticM: undefined,
@@ -2302,6 +2364,15 @@ exports.Leg = {
         if (message.xtdMonitoringStarboardM !== undefined) {
             writer.uint32(37).float(message.xtdMonitoringStarboardM);
         }
+        if (message.xtdCorridorMode !== 0) {
+            writer.uint32(40).int32(message.xtdCorridorMode);
+        }
+        for (const v of message.xtdPortBoundary) {
+            exports.XtdBoundaryPoint.encode(v, writer.uint32(50).fork()).join();
+        }
+        for (const v of message.xtdStarboardBoundary) {
+            exports.XtdBoundaryPoint.encode(v, writer.uint32(58).fork()).join();
+        }
         if (message.safetyContourM !== undefined) {
             writer.uint32(85).float(message.safetyContourM);
         }
@@ -2402,6 +2473,27 @@ exports.Leg = {
                     message.xtdMonitoringStarboardM = reader.float();
                     continue;
                 }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.xtdCorridorMode = reader.int32();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.xtdPortBoundary.push(exports.XtdBoundaryPoint.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.xtdStarboardBoundary.push(exports.XtdBoundaryPoint.decode(reader, reader.uint32()));
+                    continue;
+                }
                 case 10: {
                     if (tag !== 85) {
                         break;
@@ -2566,6 +2658,13 @@ exports.Leg = {
             xtdMonitoringStarboardM: isSet(object.xtdMonitoringStarboardM)
                 ? globalThis.Number(object.xtdMonitoringStarboardM)
                 : undefined,
+            xtdCorridorMode: isSet(object.xtdCorridorMode) ? xtdCorridorModeFromJSON(object.xtdCorridorMode) : 0,
+            xtdPortBoundary: globalThis.Array.isArray(object?.xtdPortBoundary)
+                ? object.xtdPortBoundary.map((e) => exports.XtdBoundaryPoint.fromJSON(e))
+                : [],
+            xtdStarboardBoundary: globalThis.Array.isArray(object?.xtdStarboardBoundary)
+                ? object.xtdStarboardBoundary.map((e) => exports.XtdBoundaryPoint.fromJSON(e))
+                : [],
             safetyContourM: isSet(object.safetyContourM) ? globalThis.Number(object.safetyContourM) : undefined,
             safetyDepthM: isSet(object.safetyDepthM) ? globalThis.Number(object.safetyDepthM) : undefined,
             ukcStaticM: isSet(object.ukcStaticM) ? globalThis.Number(object.ukcStaticM) : undefined,
@@ -2605,6 +2704,15 @@ exports.Leg = {
         if (message.xtdMonitoringStarboardM !== undefined) {
             obj.xtdMonitoringStarboardM = message.xtdMonitoringStarboardM;
         }
+        if (message.xtdCorridorMode !== 0) {
+            obj.xtdCorridorMode = xtdCorridorModeToJSON(message.xtdCorridorMode);
+        }
+        if (message.xtdPortBoundary?.length) {
+            obj.xtdPortBoundary = message.xtdPortBoundary.map((e) => exports.XtdBoundaryPoint.toJSON(e));
+        }
+        if (message.xtdStarboardBoundary?.length) {
+            obj.xtdStarboardBoundary = message.xtdStarboardBoundary.map((e) => exports.XtdBoundaryPoint.toJSON(e));
+        }
         if (message.safetyContourM !== undefined) {
             obj.safetyContourM = message.safetyContourM;
         }
@@ -2679,6 +2787,9 @@ exports.Leg = {
         message.xtdStarboardM = object.xtdStarboardM ?? undefined;
         message.xtdMonitoringPortM = object.xtdMonitoringPortM ?? undefined;
         message.xtdMonitoringStarboardM = object.xtdMonitoringStarboardM ?? undefined;
+        message.xtdCorridorMode = object.xtdCorridorMode ?? 0;
+        message.xtdPortBoundary = object.xtdPortBoundary?.map((e) => exports.XtdBoundaryPoint.fromPartial(e)) || [];
+        message.xtdStarboardBoundary = object.xtdStarboardBoundary?.map((e) => exports.XtdBoundaryPoint.fromPartial(e)) || [];
         message.safetyContourM = object.safetyContourM ?? undefined;
         message.safetyDepthM = object.safetyDepthM ?? undefined;
         message.ukcStaticM = object.ukcStaticM ?? undefined;
@@ -2706,6 +2817,115 @@ exports.Leg = {
     },
 };
 typeRegistry_1.messageTypeRegistry.set(exports.Leg.$type, exports.Leg);
+function createBaseXtdBoundaryPoint() {
+    return {
+        $type: "keelson.XtdBoundaryPoint",
+        position: undefined,
+        alongTrackFraction: undefined,
+        offsetM: undefined,
+        inTurn: false,
+    };
+}
+exports.XtdBoundaryPoint = {
+    $type: "keelson.XtdBoundaryPoint",
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.position !== undefined) {
+            Coordinate_1.Coordinate.encode(message.position, writer.uint32(10).fork()).join();
+        }
+        if (message.alongTrackFraction !== undefined) {
+            writer.uint32(17).double(message.alongTrackFraction);
+        }
+        if (message.offsetM !== undefined) {
+            writer.uint32(29).float(message.offsetM);
+        }
+        if (message.inTurn !== false) {
+            writer.uint32(32).bool(message.inTurn);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseXtdBoundaryPoint();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.position = Coordinate_1.Coordinate.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 17) {
+                        break;
+                    }
+                    message.alongTrackFraction = reader.double();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 29) {
+                        break;
+                    }
+                    message.offsetM = reader.float();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.inTurn = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            $type: exports.XtdBoundaryPoint.$type,
+            position: isSet(object.position) ? Coordinate_1.Coordinate.fromJSON(object.position) : undefined,
+            alongTrackFraction: isSet(object.alongTrackFraction) ? globalThis.Number(object.alongTrackFraction) : undefined,
+            offsetM: isSet(object.offsetM) ? globalThis.Number(object.offsetM) : undefined,
+            inTurn: isSet(object.inTurn) ? globalThis.Boolean(object.inTurn) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.position !== undefined) {
+            obj.position = Coordinate_1.Coordinate.toJSON(message.position);
+        }
+        if (message.alongTrackFraction !== undefined) {
+            obj.alongTrackFraction = message.alongTrackFraction;
+        }
+        if (message.offsetM !== undefined) {
+            obj.offsetM = message.offsetM;
+        }
+        if (message.inTurn !== false) {
+            obj.inTurn = message.inTurn;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.XtdBoundaryPoint.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseXtdBoundaryPoint();
+        message.position = (object.position !== undefined && object.position !== null)
+            ? Coordinate_1.Coordinate.fromPartial(object.position)
+            : undefined;
+        message.alongTrackFraction = object.alongTrackFraction ?? undefined;
+        message.offsetM = object.offsetM ?? undefined;
+        message.inTurn = object.inTurn ?? false;
+        return message;
+    },
+};
+typeRegistry_1.messageTypeRegistry.set(exports.XtdBoundaryPoint.$type, exports.XtdBoundaryPoint);
 function createBaseSchedules() {
     return { $type: "keelson.Schedules", schedule: [], extensions: undefined };
 }

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.282.dev.1",
+  "version": "0.6.0-alpha.282.dev.2",
   "description": "Keelson JavaScript SDK with Node-RED nodes",
   "main": "dist/index.js",
   "files": [