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

package/dist/interfaces/Route.js

@@ -5,8 +5,8 @@
 //   protoc               v6.30.2
 // source: Route.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionPoint = exports.ActionPoints = 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.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 = 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");
@@ -267,14 +267,25 @@ function hazardZoneTypeToJSON(object) {
     }
 }
 exports.hazardZoneTypeToJSON = hazardZoneTypeToJSON;
-/** COLREG encounter situation for an annotated leg. */
+/**
+ * COLREG encounter situation, from own ship's side. One vocabulary for the plan and the live
+ * picture: a Route leg is annotated with 1-4 only; Encounter.situation may also carry 5-6, which
+ * describe a live target and never a planned leg.
+ */
 var ColregSituation;
 (function (ColregSituation) {
     ColregSituation[ColregSituation["COLREG_SITUATION_UNSPECIFIED"] = 0] = "COLREG_SITUATION_UNSPECIFIED";
+    /** COLREG_SITUATION_OVERTAKING - own ship is overtaking */
     ColregSituation[ColregSituation["COLREG_SITUATION_OVERTAKING"] = 1] = "COLREG_SITUATION_OVERTAKING";
+    /** COLREG_SITUATION_CROSSING_STBD - target crossing from own starboard */
     ColregSituation[ColregSituation["COLREG_SITUATION_CROSSING_STBD"] = 2] = "COLREG_SITUATION_CROSSING_STBD";
+    /** COLREG_SITUATION_CROSSING_PORT - target crossing from own port */
     ColregSituation[ColregSituation["COLREG_SITUATION_CROSSING_PORT"] = 3] = "COLREG_SITUATION_CROSSING_PORT";
     ColregSituation[ColregSituation["COLREG_SITUATION_HEAD_ON"] = 4] = "COLREG_SITUATION_HEAD_ON";
+    /** COLREG_SITUATION_OVERTAKEN - target is overtaking own ship (Encounter only) */
+    ColregSituation[ColregSituation["COLREG_SITUATION_OVERTAKEN"] = 5] = "COLREG_SITUATION_OVERTAKEN";
+    /** COLREG_SITUATION_NONE - target not under way, or restricted visibility (Encounter only) */
+    ColregSituation[ColregSituation["COLREG_SITUATION_NONE"] = 6] = "COLREG_SITUATION_NONE";
     ColregSituation[ColregSituation["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(ColregSituation || (exports.ColregSituation = ColregSituation = {}));
 function colregSituationFromJSON(object) {
@@ -294,6 +305,12 @@ function colregSituationFromJSON(object) {
         case 4:
         case "COLREG_SITUATION_HEAD_ON":
             return ColregSituation.COLREG_SITUATION_HEAD_ON;
+        case 5:
+        case "COLREG_SITUATION_OVERTAKEN":
+            return ColregSituation.COLREG_SITUATION_OVERTAKEN;
+        case 6:
+        case "COLREG_SITUATION_NONE":
+            return ColregSituation.COLREG_SITUATION_NONE;
         case -1:
         case "UNRECOGNIZED":
         default:
@@ -313,6 +330,10 @@ function colregSituationToJSON(object) {
             return "COLREG_SITUATION_CROSSING_PORT";
         case ColregSituation.COLREG_SITUATION_HEAD_ON:
             return "COLREG_SITUATION_HEAD_ON";
+        case ColregSituation.COLREG_SITUATION_OVERTAKEN:
+            return "COLREG_SITUATION_OVERTAKEN";
+        case ColregSituation.COLREG_SITUATION_NONE:
+            return "COLREG_SITUATION_NONE";
         case ColregSituation.UNRECOGNIZED:
         default:
             return "UNRECOGNIZED";
@@ -411,6 +432,123 @@ 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.
+     * xtd_port_m / xtd_starboard_m still carry a nominal limit for a monitor
+     * 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_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
+ * uniqueness) or left closing to consumer convention (silently wrong the first
+ * time a consumer chooses not to loop). This field makes the author say.
+ *
+ * An enum rather than a bool, like every other classification in this file:
+ * OPEN says closure was considered and declined, and there is room for a
+ * third topology (out-and-back). UNSPECIFIED MUST be read as OPEN; that is
+ * the fail-safe direction, since sailing a point-to-point route as a circuit
+ * takes the vessel over unplanned water. Terminal behaviour (stop, hold, go
+ * round again) is execution policy and belongs on keelson.Voyage, not here.
+ * See protocol-specification.md §6.2.1.
+ */
+var RouteTopology;
+(function (RouteTopology) {
+    RouteTopology[RouteTopology["ROUTE_TOPOLOGY_UNSPECIFIED"] = 0] = "ROUTE_TOPOLOGY_UNSPECIFIED";
+    /**
+     * ROUTE_TOPOLOGY_OPEN - Runs from the first waypoint to the last and ends there. The last
+     * waypoint has no outgoing leg.
+     */
+    RouteTopology[RouteTopology["ROUTE_TOPOLOGY_OPEN"] = 1] = "ROUTE_TOPOLOGY_OPEN";
+    /**
+     * ROUTE_TOPOLOGY_CLOSED - A circuit: the last waypoint's outgoing leg terminates at the first
+     * waypoint, which is NOT repeated at the end of the list.
+     */
+    RouteTopology[RouteTopology["ROUTE_TOPOLOGY_CLOSED"] = 2] = "ROUTE_TOPOLOGY_CLOSED";
+    RouteTopology[RouteTopology["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(RouteTopology || (exports.RouteTopology = RouteTopology = {}));
+function routeTopologyFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "ROUTE_TOPOLOGY_UNSPECIFIED":
+            return RouteTopology.ROUTE_TOPOLOGY_UNSPECIFIED;
+        case 1:
+        case "ROUTE_TOPOLOGY_OPEN":
+            return RouteTopology.ROUTE_TOPOLOGY_OPEN;
+        case 2:
+        case "ROUTE_TOPOLOGY_CLOSED":
+            return RouteTopology.ROUTE_TOPOLOGY_CLOSED;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return RouteTopology.UNRECOGNIZED;
+    }
+}
+exports.routeTopologyFromJSON = routeTopologyFromJSON;
+function routeTopologyToJSON(object) {
+    switch (object) {
+        case RouteTopology.ROUTE_TOPOLOGY_UNSPECIFIED:
+            return "ROUTE_TOPOLOGY_UNSPECIFIED";
+        case RouteTopology.ROUTE_TOPOLOGY_OPEN:
+            return "ROUTE_TOPOLOGY_OPEN";
+        case RouteTopology.ROUTE_TOPOLOGY_CLOSED:
+            return "ROUTE_TOPOLOGY_CLOSED";
+        case RouteTopology.UNRECOGNIZED:
+        default:
+            return "UNRECOGNIZED";
+    }
+}
+exports.routeTopologyToJSON = routeTopologyToJSON;
 /**
  * Lifecycle status for the route artifact (authoring + quality).
  * Execution-side state (vessel sailing, paused, completed) lives on
@@ -1696,7 +1834,7 @@ exports.RouteInfo = {
     },
 };
 function createBaseWaypoints() {
-    return { defaults: undefined, waypoint: [], extensions: undefined };
+    return { defaults: undefined, waypoint: [], topology: 0, extensions: undefined };
 }
 exports.Waypoints = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -1706,6 +1844,9 @@ exports.Waypoints = {
         for (const v of message.waypoint) {
             exports.Waypoint.encode(v, writer.uint32(18).fork()).join();
         }
+        if (message.topology !== 0) {
+            writer.uint32(24).int32(message.topology);
+        }
         if (message.extensions !== undefined) {
             exports.Extensions.encode(message.extensions, writer.uint32(794).fork()).join();
         }
@@ -1732,6 +1873,13 @@ exports.Waypoints = {
                     message.waypoint.push(exports.Waypoint.decode(reader, reader.uint32()));
                     continue;
                 }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.topology = reader.int32();
+                    continue;
+                }
                 case 99: {
                     if (tag !== 794) {
                         break;
@@ -1751,6 +1899,7 @@ exports.Waypoints = {
         return {
             defaults: isSet(object.defaults) ? exports.DefaultWaypoint.fromJSON(object.defaults) : undefined,
             waypoint: globalThis.Array.isArray(object?.waypoint) ? object.waypoint.map((e) => exports.Waypoint.fromJSON(e)) : [],
+            topology: isSet(object.topology) ? routeTopologyFromJSON(object.topology) : 0,
             extensions: isSet(object.extensions) ? exports.Extensions.fromJSON(object.extensions) : undefined,
         };
     },
@@ -1762,6 +1911,9 @@ exports.Waypoints = {
         if (message.waypoint?.length) {
             obj.waypoint = message.waypoint.map((e) => exports.Waypoint.toJSON(e));
         }
+        if (message.topology !== 0) {
+            obj.topology = routeTopologyToJSON(message.topology);
+        }
         if (message.extensions !== undefined) {
             obj.extensions = exports.Extensions.toJSON(message.extensions);
         }
@@ -1776,6 +1928,7 @@ exports.Waypoints = {
             ? exports.DefaultWaypoint.fromPartial(object.defaults)
             : undefined;
         message.waypoint = object.waypoint?.map((e) => exports.Waypoint.fromPartial(e)) || [];
+        message.topology = object.topology ?? 0;
         message.extensions = (object.extensions !== undefined && object.extensions !== null)
             ? exports.Extensions.fromPartial(object.extensions)
             : undefined;
@@ -2122,6 +2275,9 @@ function createBaseLeg() {
         xtdStarboardM: undefined,
         xtdMonitoringPortM: undefined,
         xtdMonitoringStarboardM: undefined,
+        xtdCorridorMode: 0,
+        xtdPortBoundary: [],
+        xtdStarboardBoundary: [],
         safetyContourM: undefined,
         safetyDepthM: undefined,
         ukcStaticM: undefined,
@@ -2159,6 +2315,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);
         }
@@ -2259,6 +2424,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;
@@ -2422,6 +2608,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,
@@ -2461,6 +2654,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;
         }
@@ -2535,6 +2737,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;
@@ -2561,6 +2766,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/interfaces/RoutePlanner.d.ts

@@ -1,6 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { Coordinate } from "./Coordinate";
-import { Extensions, Route, RouteInfo, RouteRef } from "./Route";
+import { Extensions, Route, RouteInfo, RouteRef, RouteTopology } from "./Route";
 export declare const protobufPackage = "keelson.interfaces.route_planner";
 /**
  * What the planner should optimise for. A closed set, not the free-form
@@ -46,6 +46,8 @@ export interface PlanRouteRequest {
      * `Coordinate`, not `Waypoint` — these are the positions the route must
      * touch, not planned waypoints with turn radii and speeds. Those are the
      * planner's output, not its input.
+     * Under `topology = CLOSED` this list is the circuit's via-points: the first
+     * is both departure and final arrival, and it is NOT repeated at the end.
      */
     waypoints: Coordinate[];
     /**
@@ -64,6 +66,15 @@ export interface PlanRouteRequest {
      * reply with more.
      */
     maxAlternatives: number;
+    /**
+     * Whether the caller wants a point-to-point route or a circuit. Without it
+     * a circuit is unrequestable and the planner's own convention becomes the
+     * new implicit rule, one layer up from where it was just removed. Under
+     * CLOSED the planner MUST set `Waypoints.topology` on every alternative and
+     * close it with a leg on the last waypoint, never by appending a copy of
+     * `waypoints[0]`. See protocol-specification.md §6.2.1.
+     */
+    topology: RouteTopology;
     /**
      * Vendor-specific planning inputs — deployment tunings, experimental cost
      * profiles. Anything that becomes generally useful should graduate to a
@@ -94,6 +105,13 @@ export declare const RoutePlannerDefinition: {
          * Re-run navigability and validation against a (possibly hand-edited)
          * route, replying it annotated with `challenges`, `issues` and `status`.
          * Takes a whole `keelson.Route` because that is genuinely the input.
+         *
+         * The closure invariants of §6.2.1 are part of what is validated, and a
+         * breach is a `RouteIssue`: the last waypoint carries a `leg` if and only if
+         * the topology is CLOSED, the first waypoint is not repeated at the end,
+         * waypoint ids are unique, and a CLOSED route has at least two waypoints.
+         * Exactly two is legal but coincident out-and-back geometry — a
+         * `RouteChallenge`, not an error.
          */
         readonly validate_route: {
             readonly name: "validate_route";

package/dist/interfaces/RoutePlanner.js

@@ -87,7 +87,7 @@ function optimizationGoalToJSON(object) {
 }
 exports.optimizationGoalToJSON = optimizationGoalToJSON;
 function createBasePlanRouteRequest() {
-    return { waypoints: [], constraints: undefined, goal: 0, maxAlternatives: 0, extensions: undefined };
+    return { waypoints: [], constraints: undefined, goal: 0, maxAlternatives: 0, topology: 0, extensions: undefined };
 }
 exports.PlanRouteRequest = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -103,6 +103,9 @@ exports.PlanRouteRequest = {
         if (message.maxAlternatives !== 0) {
             writer.uint32(32).uint32(message.maxAlternatives);
         }
+        if (message.topology !== 0) {
+            writer.uint32(40).int32(message.topology);
+        }
         if (message.extensions !== undefined) {
             Route_1.Extensions.encode(message.extensions, writer.uint32(794).fork()).join();
         }
@@ -143,6 +146,13 @@ exports.PlanRouteRequest = {
                     message.maxAlternatives = reader.uint32();
                     continue;
                 }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.topology = reader.int32();
+                    continue;
+                }
                 case 99: {
                     if (tag !== 794) {
                         break;
@@ -166,6 +176,7 @@ exports.PlanRouteRequest = {
             constraints: isSet(object.constraints) ? Route_1.RouteInfo.fromJSON(object.constraints) : undefined,
             goal: isSet(object.goal) ? optimizationGoalFromJSON(object.goal) : 0,
             maxAlternatives: isSet(object.maxAlternatives) ? globalThis.Number(object.maxAlternatives) : 0,
+            topology: isSet(object.topology) ? (0, Route_1.routeTopologyFromJSON)(object.topology) : 0,
             extensions: isSet(object.extensions) ? Route_1.Extensions.fromJSON(object.extensions) : undefined,
         };
     },
@@ -183,6 +194,9 @@ exports.PlanRouteRequest = {
         if (message.maxAlternatives !== 0) {
             obj.maxAlternatives = Math.round(message.maxAlternatives);
         }
+        if (message.topology !== 0) {
+            obj.topology = (0, Route_1.routeTopologyToJSON)(message.topology);
+        }
         if (message.extensions !== undefined) {
             obj.extensions = Route_1.Extensions.toJSON(message.extensions);
         }
@@ -199,6 +213,7 @@ exports.PlanRouteRequest = {
             : undefined;
         message.goal = object.goal ?? 0;
         message.maxAlternatives = object.maxAlternatives ?? 0;
+        message.topology = object.topology ?? 0;
         message.extensions = (object.extensions !== undefined && object.extensions !== null)
             ? Route_1.Extensions.fromPartial(object.extensions)
             : undefined;
@@ -226,6 +241,13 @@ exports.RoutePlannerDefinition = {
          * Re-run navigability and validation against a (possibly hand-edited)
          * route, replying it annotated with `challenges`, `issues` and `status`.
          * Takes a whole `keelson.Route` because that is genuinely the input.
+         *
+         * The closure invariants of §6.2.1 are part of what is validated, and a
+         * breach is a `RouteIssue`: the last waypoint carries a `leg` if and only if
+         * the topology is CLOSED, the first waypoint is not repeated at the end,
+         * waypoint ids are unique, and a CLOSED route has at least two waypoints.
+         * Exactly two is legal but coincident out-and-back geometry — a
+         * `RouteChallenge`, not an error.
          */
         validate_route: {
             name: "validate_route",