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

package/dist/interfaces/ReplayControl.d.ts

@@ -22,6 +22,38 @@ export interface ListFilesResponse {
     baseDirectory: string;
     files: FileInfo[];
 }
+export interface DescribeFileRequest {
+    /**
+     * Path relative to the replayer's base directory, as in load_file. The file
+     * need not be loaded — a client can inspect a recording before playing it.
+     */
+    path: string;
+}
+/** One channel (topic) in the file, and when it spoke. */
+export interface ChannelInfo {
+    topic: string;
+    /** The channel's schema name as recorded, e.g. "keelson.TimestampedFloat". */
+    schemaName: string;
+    /** The channel's message encoding as recorded, e.g. "protobuf". */
+    messageEncoding: string;
+    messageCount: number;
+    /**
+     * log_time of the channel's first and last message. Unset when the channel
+     * recorded no messages. Exact, not the bounds of the chunks it appears in.
+     */
+    firstTime: Date | undefined;
+    lastTime: Date | undefined;
+}
+export interface DescribeFileResponse {
+    file: FileInfo | undefined;
+    channels: ChannelInfo[];
+    /**
+     * True when the file carried no summary or no chunk indexes, so the replayer
+     * had to read it end to end. The figures are still exact; the call was just
+     * proportional to the file's size rather than to its number of chunks.
+     */
+    fromScan: boolean;
+}
 export interface LoadFileRequest {
     path: string;
 }
@@ -30,7 +62,11 @@ export interface SeekRequest {
     target: Date | undefined;
 }
 export interface SetSpeedRequest {
-    /** Playback speed multiplier; expected range [0.25, 4.0]. */
+    /**
+     * Playback speed multiplier; expected range [0.25, 20.0]. At high speeds a
+     * recording heavy with images or point clouds is published as fast as the
+     * replayer can manage and lags wall time; no message is dropped.
+     */
     speed: number;
 }
 export interface SetLoopRequest {
@@ -42,6 +78,9 @@ export interface ReplaySuccessResponse {
 export declare const FileInfo: MessageFns<FileInfo>;
 export declare const ListFilesRequest: MessageFns<ListFilesRequest>;
 export declare const ListFilesResponse: MessageFns<ListFilesResponse>;
+export declare const DescribeFileRequest: MessageFns<DescribeFileRequest>;
+export declare const ChannelInfo: MessageFns<ChannelInfo>;
+export declare const DescribeFileResponse: MessageFns<DescribeFileResponse>;
 export declare const LoadFileRequest: MessageFns<LoadFileRequest>;
 export declare const SeekRequest: MessageFns<SeekRequest>;
 export declare const SetSpeedRequest: MessageFns<SetSpeedRequest>;
@@ -60,6 +99,15 @@ export declare const ReplayControlDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        /** Per-channel message counts and first/last message times for one file. */
+        readonly describe_file: {
+            readonly name: "describe_file";
+            readonly requestType: MessageFns<DescribeFileRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<DescribeFileResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly load_file: {
             readonly name: "load_file";
             readonly requestType: MessageFns<LoadFileRequest>;

package/dist/interfaces/ReplayControl.js

@@ -5,7 +5,7 @@
 //   protoc               v6.30.2
 // source: ReplayControl.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReplayControlDefinition = exports.ReplaySuccessResponse = exports.SetLoopRequest = exports.SetSpeedRequest = exports.SeekRequest = exports.LoadFileRequest = exports.ListFilesResponse = exports.ListFilesRequest = exports.FileInfo = exports.protobufPackage = void 0;
+exports.ReplayControlDefinition = exports.ReplaySuccessResponse = exports.SetLoopRequest = exports.SetSpeedRequest = exports.SeekRequest = exports.LoadFileRequest = exports.DescribeFileResponse = exports.ChannelInfo = exports.DescribeFileRequest = exports.ListFilesResponse = exports.ListFilesRequest = exports.FileInfo = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const empty_1 = require("./google/protobuf/empty");
@@ -283,6 +283,270 @@ exports.ListFilesResponse = {
         return message;
     },
 };
+function createBaseDescribeFileRequest() {
+    return { path: "" };
+}
+exports.DescribeFileRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.path !== "") {
+            writer.uint32(10).string(message.path);
+        }
+        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 = createBaseDescribeFileRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.path = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { path: isSet(object.path) ? globalThis.String(object.path) : "" };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.path !== "") {
+            obj.path = message.path;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.DescribeFileRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseDescribeFileRequest();
+        message.path = object.path ?? "";
+        return message;
+    },
+};
+function createBaseChannelInfo() {
+    return { topic: "", schemaName: "", messageEncoding: "", messageCount: 0, firstTime: undefined, lastTime: undefined };
+}
+exports.ChannelInfo = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.topic !== "") {
+            writer.uint32(10).string(message.topic);
+        }
+        if (message.schemaName !== "") {
+            writer.uint32(18).string(message.schemaName);
+        }
+        if (message.messageEncoding !== "") {
+            writer.uint32(26).string(message.messageEncoding);
+        }
+        if (message.messageCount !== 0) {
+            writer.uint32(32).uint64(message.messageCount);
+        }
+        if (message.firstTime !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.firstTime), writer.uint32(42).fork()).join();
+        }
+        if (message.lastTime !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.lastTime), writer.uint32(50).fork()).join();
+        }
+        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 = createBaseChannelInfo();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.topic = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.schemaName = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.messageEncoding = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.messageCount = longToNumber(reader.uint64());
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.firstTime = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.lastTime = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            topic: isSet(object.topic) ? globalThis.String(object.topic) : "",
+            schemaName: isSet(object.schemaName) ? globalThis.String(object.schemaName) : "",
+            messageEncoding: isSet(object.messageEncoding) ? globalThis.String(object.messageEncoding) : "",
+            messageCount: isSet(object.messageCount) ? globalThis.Number(object.messageCount) : 0,
+            firstTime: isSet(object.firstTime) ? fromJsonTimestamp(object.firstTime) : undefined,
+            lastTime: isSet(object.lastTime) ? fromJsonTimestamp(object.lastTime) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.topic !== "") {
+            obj.topic = message.topic;
+        }
+        if (message.schemaName !== "") {
+            obj.schemaName = message.schemaName;
+        }
+        if (message.messageEncoding !== "") {
+            obj.messageEncoding = message.messageEncoding;
+        }
+        if (message.messageCount !== 0) {
+            obj.messageCount = Math.round(message.messageCount);
+        }
+        if (message.firstTime !== undefined) {
+            obj.firstTime = message.firstTime.toISOString();
+        }
+        if (message.lastTime !== undefined) {
+            obj.lastTime = message.lastTime.toISOString();
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ChannelInfo.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseChannelInfo();
+        message.topic = object.topic ?? "";
+        message.schemaName = object.schemaName ?? "";
+        message.messageEncoding = object.messageEncoding ?? "";
+        message.messageCount = object.messageCount ?? 0;
+        message.firstTime = object.firstTime ?? undefined;
+        message.lastTime = object.lastTime ?? undefined;
+        return message;
+    },
+};
+function createBaseDescribeFileResponse() {
+    return { file: undefined, channels: [], fromScan: false };
+}
+exports.DescribeFileResponse = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.file !== undefined) {
+            exports.FileInfo.encode(message.file, writer.uint32(10).fork()).join();
+        }
+        for (const v of message.channels) {
+            exports.ChannelInfo.encode(v, writer.uint32(18).fork()).join();
+        }
+        if (message.fromScan !== false) {
+            writer.uint32(24).bool(message.fromScan);
+        }
+        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 = createBaseDescribeFileResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.file = exports.FileInfo.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.channels.push(exports.ChannelInfo.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.fromScan = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            file: isSet(object.file) ? exports.FileInfo.fromJSON(object.file) : undefined,
+            channels: globalThis.Array.isArray(object?.channels)
+                ? object.channels.map((e) => exports.ChannelInfo.fromJSON(e))
+                : [],
+            fromScan: isSet(object.fromScan) ? globalThis.Boolean(object.fromScan) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.file !== undefined) {
+            obj.file = exports.FileInfo.toJSON(message.file);
+        }
+        if (message.channels?.length) {
+            obj.channels = message.channels.map((e) => exports.ChannelInfo.toJSON(e));
+        }
+        if (message.fromScan !== false) {
+            obj.fromScan = message.fromScan;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.DescribeFileResponse.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseDescribeFileResponse();
+        message.file = (object.file !== undefined && object.file !== null) ? exports.FileInfo.fromPartial(object.file) : undefined;
+        message.channels = object.channels?.map((e) => exports.ChannelInfo.fromPartial(e)) || [];
+        message.fromScan = object.fromScan ?? false;
+        return message;
+    },
+};
 function createBaseLoadFileRequest() {
     return { path: "" };
 }
@@ -536,6 +800,15 @@ exports.ReplayControlDefinition = {
             responseStream: false,
             options: {},
         },
+        /** Per-channel message counts and first/last message times for one file. */
+        describe_file: {
+            name: "describe_file",
+            requestType: exports.DescribeFileRequest,
+            requestStream: false,
+            responseType: exports.DescribeFileResponse,
+            responseStream: false,
+            options: {},
+        },
         load_file: {
             name: "load_file",
             requestType: exports.LoadFileRequest,

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
@@ -382,6 +410,9 @@ export interface Waypoints {
  * route sets no default speed" as distinct from "this route defaults to
  * zero", and a consumer merging defaults into a waypoint cannot tell which
  * it was handed.
+ *
+ * `Leg.xtd_corridor_mode` and both boundary lists are ignored here: a drawn
+ * corridor belongs to one stretch of water and cannot be a default (§6.2.2).
  */
 export interface DefaultWaypoint {
     leg: Leg | undefined;
@@ -460,12 +491,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 +562,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 +776,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>;