@rise-maritime/keelson-js 0.5.3 → 0.6.0-alpha.202.dev.1

package/dist/payloads/RouteEditAuthority.js

@@ -0,0 +1,380 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.1
+//   protoc               v6.30.2
+// source: RouteEditAuthority.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteEditRequest = exports.RouteEditAuthority = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+const timestamp_1 = require("./google/protobuf/timestamp");
+const typeRegistry_1 = require("./typeRegistry");
+function createBaseRouteEditAuthority() {
+    return {
+        $type: "keelson.RouteEditAuthority",
+        routeId: "",
+        controllerId: "",
+        controllerSite: "",
+        token: "",
+        grantedAt: undefined,
+        expiresAt: undefined,
+        lastHeartbeat: undefined,
+        leaseTtlSeconds: 0,
+        heartbeatIntervalSeconds: 0,
+        released: false,
+    };
+}
+exports.RouteEditAuthority = {
+    $type: "keelson.RouteEditAuthority",
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.routeId !== "") {
+            writer.uint32(10).string(message.routeId);
+        }
+        if (message.controllerId !== "") {
+            writer.uint32(18).string(message.controllerId);
+        }
+        if (message.controllerSite !== "") {
+            writer.uint32(26).string(message.controllerSite);
+        }
+        if (message.token !== "") {
+            writer.uint32(34).string(message.token);
+        }
+        if (message.grantedAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.grantedAt), writer.uint32(82).fork()).join();
+        }
+        if (message.expiresAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.expiresAt), writer.uint32(90).fork()).join();
+        }
+        if (message.lastHeartbeat !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.lastHeartbeat), writer.uint32(98).fork()).join();
+        }
+        if (message.leaseTtlSeconds !== 0) {
+            writer.uint32(104).uint32(message.leaseTtlSeconds);
+        }
+        if (message.heartbeatIntervalSeconds !== 0) {
+            writer.uint32(112).uint32(message.heartbeatIntervalSeconds);
+        }
+        if (message.released !== false) {
+            writer.uint32(160).bool(message.released);
+        }
+        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 = createBaseRouteEditAuthority();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.routeId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.controllerId = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.controllerSite = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.token = reader.string();
+                    continue;
+                }
+                case 10: {
+                    if (tag !== 82) {
+                        break;
+                    }
+                    message.grantedAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 11: {
+                    if (tag !== 90) {
+                        break;
+                    }
+                    message.expiresAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 12: {
+                    if (tag !== 98) {
+                        break;
+                    }
+                    message.lastHeartbeat = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 13: {
+                    if (tag !== 104) {
+                        break;
+                    }
+                    message.leaseTtlSeconds = reader.uint32();
+                    continue;
+                }
+                case 14: {
+                    if (tag !== 112) {
+                        break;
+                    }
+                    message.heartbeatIntervalSeconds = reader.uint32();
+                    continue;
+                }
+                case 20: {
+                    if (tag !== 160) {
+                        break;
+                    }
+                    message.released = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            $type: exports.RouteEditAuthority.$type,
+            routeId: isSet(object.routeId) ? globalThis.String(object.routeId) : "",
+            controllerId: isSet(object.controllerId) ? globalThis.String(object.controllerId) : "",
+            controllerSite: isSet(object.controllerSite) ? globalThis.String(object.controllerSite) : "",
+            token: isSet(object.token) ? globalThis.String(object.token) : "",
+            grantedAt: isSet(object.grantedAt) ? fromJsonTimestamp(object.grantedAt) : undefined,
+            expiresAt: isSet(object.expiresAt) ? fromJsonTimestamp(object.expiresAt) : undefined,
+            lastHeartbeat: isSet(object.lastHeartbeat) ? fromJsonTimestamp(object.lastHeartbeat) : undefined,
+            leaseTtlSeconds: isSet(object.leaseTtlSeconds) ? globalThis.Number(object.leaseTtlSeconds) : 0,
+            heartbeatIntervalSeconds: isSet(object.heartbeatIntervalSeconds)
+                ? globalThis.Number(object.heartbeatIntervalSeconds)
+                : 0,
+            released: isSet(object.released) ? globalThis.Boolean(object.released) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.routeId !== "") {
+            obj.routeId = message.routeId;
+        }
+        if (message.controllerId !== "") {
+            obj.controllerId = message.controllerId;
+        }
+        if (message.controllerSite !== "") {
+            obj.controllerSite = message.controllerSite;
+        }
+        if (message.token !== "") {
+            obj.token = message.token;
+        }
+        if (message.grantedAt !== undefined) {
+            obj.grantedAt = message.grantedAt.toISOString();
+        }
+        if (message.expiresAt !== undefined) {
+            obj.expiresAt = message.expiresAt.toISOString();
+        }
+        if (message.lastHeartbeat !== undefined) {
+            obj.lastHeartbeat = message.lastHeartbeat.toISOString();
+        }
+        if (message.leaseTtlSeconds !== 0) {
+            obj.leaseTtlSeconds = Math.round(message.leaseTtlSeconds);
+        }
+        if (message.heartbeatIntervalSeconds !== 0) {
+            obj.heartbeatIntervalSeconds = Math.round(message.heartbeatIntervalSeconds);
+        }
+        if (message.released !== false) {
+            obj.released = message.released;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RouteEditAuthority.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseRouteEditAuthority();
+        message.routeId = object.routeId ?? "";
+        message.controllerId = object.controllerId ?? "";
+        message.controllerSite = object.controllerSite ?? "";
+        message.token = object.token ?? "";
+        message.grantedAt = object.grantedAt ?? undefined;
+        message.expiresAt = object.expiresAt ?? undefined;
+        message.lastHeartbeat = object.lastHeartbeat ?? undefined;
+        message.leaseTtlSeconds = object.leaseTtlSeconds ?? 0;
+        message.heartbeatIntervalSeconds = object.heartbeatIntervalSeconds ?? 0;
+        message.released = object.released ?? false;
+        return message;
+    },
+};
+typeRegistry_1.messageTypeRegistry.set(exports.RouteEditAuthority.$type, exports.RouteEditAuthority);
+function createBaseRouteEditRequest() {
+    return {
+        $type: "keelson.RouteEditRequest",
+        routeId: "",
+        requesterId: "",
+        requesterSite: "",
+        requestedAt: undefined,
+        reason: "",
+        force: false,
+    };
+}
+exports.RouteEditRequest = {
+    $type: "keelson.RouteEditRequest",
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.routeId !== "") {
+            writer.uint32(10).string(message.routeId);
+        }
+        if (message.requesterId !== "") {
+            writer.uint32(18).string(message.requesterId);
+        }
+        if (message.requesterSite !== "") {
+            writer.uint32(26).string(message.requesterSite);
+        }
+        if (message.requestedAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.requestedAt), writer.uint32(34).fork()).join();
+        }
+        if (message.reason !== "") {
+            writer.uint32(42).string(message.reason);
+        }
+        if (message.force !== false) {
+            writer.uint32(48).bool(message.force);
+        }
+        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 = createBaseRouteEditRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.routeId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.requesterId = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.requesterSite = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.requestedAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.reason = reader.string();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 48) {
+                        break;
+                    }
+                    message.force = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            $type: exports.RouteEditRequest.$type,
+            routeId: isSet(object.routeId) ? globalThis.String(object.routeId) : "",
+            requesterId: isSet(object.requesterId) ? globalThis.String(object.requesterId) : "",
+            requesterSite: isSet(object.requesterSite) ? globalThis.String(object.requesterSite) : "",
+            requestedAt: isSet(object.requestedAt) ? fromJsonTimestamp(object.requestedAt) : undefined,
+            reason: isSet(object.reason) ? globalThis.String(object.reason) : "",
+            force: isSet(object.force) ? globalThis.Boolean(object.force) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.routeId !== "") {
+            obj.routeId = message.routeId;
+        }
+        if (message.requesterId !== "") {
+            obj.requesterId = message.requesterId;
+        }
+        if (message.requesterSite !== "") {
+            obj.requesterSite = message.requesterSite;
+        }
+        if (message.requestedAt !== undefined) {
+            obj.requestedAt = message.requestedAt.toISOString();
+        }
+        if (message.reason !== "") {
+            obj.reason = message.reason;
+        }
+        if (message.force !== false) {
+            obj.force = message.force;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RouteEditRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseRouteEditRequest();
+        message.routeId = object.routeId ?? "";
+        message.requesterId = object.requesterId ?? "";
+        message.requesterSite = object.requesterSite ?? "";
+        message.requestedAt = object.requestedAt ?? undefined;
+        message.reason = object.reason ?? "";
+        message.force = object.force ?? false;
+        return message;
+    },
+};
+typeRegistry_1.messageTypeRegistry.set(exports.RouteEditRequest.$type, exports.RouteEditRequest);
+function toTimestamp(date) {
+    const seconds = Math.trunc(date.getTime() / 1000);
+    const nanos = (date.getTime() % 1000) * 1000000;
+    return { $type: "google.protobuf.Timestamp", seconds, nanos };
+}
+function fromTimestamp(t) {
+    let millis = (t.seconds || 0) * 1000;
+    millis += (t.nanos || 0) / 1000000;
+    return new globalThis.Date(millis);
+}
+function fromJsonTimestamp(o) {
+    if (o instanceof globalThis.Date) {
+        return o;
+    }
+    else if (typeof o === "string") {
+        return new globalThis.Date(o);
+    }
+    else {
+        return fromTimestamp(timestamp_1.Timestamp.fromJSON(o));
+    }
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/payloads/RouteExecution.d.ts

@@ -0,0 +1,64 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { RouteRef } from "./Route";
+export interface RouteExecution {
+    $type: "keelson.RouteExecution";
+    /** Sample timestamp. */
+    timestamp: Date | undefined;
+    /** Voyage this sample belongs to. */
+    voyageId: string;
+    routeRef: RouteRef | undefined;
+    currentLegFromWaypointId?: string | undefined;
+    /**
+     * Stable id of the next waypoint to be reached. Unset before departure and
+     * after final arrival.
+     */
+    nextWaypointId?: string | undefined;
+    /** Great-circle distance to the next waypoint (metres). */
+    distanceToNextWaypointM: number;
+    /** Cross-track distance, signed: +stbd / -port of the planned track (metres). */
+    xtdM: number;
+    /** True bearing to the next waypoint (degrees). */
+    bearingToNextDeg: number;
+    /** -- ETAs ------------------------------------------------------------------- */
+    etaNextWaypoint: Date | undefined;
+    etaArrival: Date | undefined;
+    /**
+     * -- Deviation state --------------------------------------------------------
+     * True when |xtd_m| exceeds the leg's XTD limit; used by UI to flip colour
+     * and trigger alarms.
+     */
+    deviationActive: boolean;
+    /**
+     * Threshold used to determine deviation_active (metres). Sourced from the
+     * current Leg's xtd_port_m / xtd_stbd_m or a configured fallback.
+     */
+    deviationThresholdM: number;
+    /**
+     * -- Kinematics (echo of own-ship state for convenience) --------------------
+     * Knots to match the bus convention (subjects.yaml: speed_over_ground_knots)
+     * and the speed units used everywhere else on Route/Leg/ScheduleElement.
+     */
+    speedOverGroundKnots: number;
+    courseOverGroundDeg: number;
+}
+export declare const RouteExecution: MessageFns<RouteExecution, "keelson.RouteExecution">;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in Exclude<keyof T, "$type">]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P> | "$type">]: never;
+};
+interface MessageFns<T, V extends string> {
+    readonly $type: V;
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};