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

package/dist/payloads/NavigationState.js

@@ -5,7 +5,7 @@
 //   protoc               v6.30.2
 // source: NavigationState.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GuidanceOrder_Hold = exports.GuidanceOrder_Track = exports.GuidanceOrder = exports.NavigationState = exports.navigationState_SubModeToJSON = exports.navigationState_SubModeFromJSON = exports.NavigationState_SubMode = exports.navigationState_ModeToJSON = exports.navigationState_ModeFromJSON = exports.NavigationState_Mode = void 0;
+exports.NavigationState = exports.navigationState_SubModeToJSON = exports.navigationState_SubModeFromJSON = exports.NavigationState_SubMode = exports.navigationState_ModeToJSON = exports.navigationState_ModeFromJSON = exports.NavigationState_Mode = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const OperationalAuthority_1 = require("./OperationalAuthority");
@@ -96,8 +96,6 @@ var NavigationState_SubMode;
     NavigationState_SubMode[NavigationState_SubMode["SUB_MODE_HOLDING"] = 3] = "SUB_MODE_HOLDING";
     /** SUB_MODE_REROUTING - awaiting a new route edition */
     NavigationState_SubMode[NavigationState_SubMode["SUB_MODE_REROUTING"] = 4] = "SUB_MODE_REROUTING";
-    /** SUB_MODE_STEERING - holding an ordered course or heading, off the track (GuidanceOrder) */
-    NavigationState_SubMode[NavigationState_SubMode["SUB_MODE_STEERING"] = 5] = "SUB_MODE_STEERING";
     NavigationState_SubMode[NavigationState_SubMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
 })(NavigationState_SubMode || (exports.NavigationState_SubMode = NavigationState_SubMode = {}));
 function navigationState_SubModeFromJSON(object) {
@@ -117,9 +115,6 @@ function navigationState_SubModeFromJSON(object) {
         case 4:
         case "SUB_MODE_REROUTING":
             return NavigationState_SubMode.SUB_MODE_REROUTING;
-        case 5:
-        case "SUB_MODE_STEERING":
-            return NavigationState_SubMode.SUB_MODE_STEERING;
         case -1:
         case "UNRECOGNIZED":
         default:
@@ -139,8 +134,6 @@ function navigationState_SubModeToJSON(object) {
             return "SUB_MODE_HOLDING";
         case NavigationState_SubMode.SUB_MODE_REROUTING:
             return "SUB_MODE_REROUTING";
-        case NavigationState_SubMode.SUB_MODE_STEERING:
-            return "SUB_MODE_STEERING";
         case NavigationState_SubMode.UNRECOGNIZED:
         default:
             return "UNRECOGNIZED";
@@ -160,7 +153,6 @@ function createBaseNavigationState() {
         connHeld: false,
         reason: "",
         degradedInputs: [],
-        guidanceOrder: undefined,
     };
 }
 exports.NavigationState = {
@@ -196,9 +188,6 @@ exports.NavigationState = {
         for (const v of message.degradedInputs) {
             writer.uint32(82).string(v);
         }
-        if (message.guidanceOrder !== undefined) {
-            exports.GuidanceOrder.encode(message.guidanceOrder, writer.uint32(90).fork()).join();
-        }
         return writer;
     },
     decode(input, length) {
@@ -278,13 +267,6 @@ exports.NavigationState = {
                     message.degradedInputs.push(reader.string());
                     continue;
                 }
-                case 11: {
-                    if (tag !== 90) {
-                        break;
-                    }
-                    message.guidanceOrder = exports.GuidanceOrder.decode(reader, reader.uint32());
-                    continue;
-                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -312,7 +294,6 @@ exports.NavigationState = {
             degradedInputs: globalThis.Array.isArray(object?.degradedInputs)
                 ? object.degradedInputs.map((e) => globalThis.String(e))
                 : [],
-            guidanceOrder: isSet(object.guidanceOrder) ? exports.GuidanceOrder.fromJSON(object.guidanceOrder) : undefined,
         };
     },
     toJSON(message) {
@@ -347,9 +328,6 @@ exports.NavigationState = {
         if (message.degradedInputs?.length) {
             obj.degradedInputs = message.degradedInputs;
         }
-        if (message.guidanceOrder !== undefined) {
-            obj.guidanceOrder = exports.GuidanceOrder.toJSON(message.guidanceOrder);
-        }
         return obj;
     },
     create(base) {
@@ -369,239 +347,10 @@ exports.NavigationState = {
         message.connHeld = object.connHeld ?? false;
         message.reason = object.reason ?? "";
         message.degradedInputs = object.degradedInputs?.map((e) => e) || [];
-        message.guidanceOrder = (object.guidanceOrder !== undefined && object.guidanceOrder !== null)
-            ? exports.GuidanceOrder.fromPartial(object.guidanceOrder)
-            : undefined;
         return message;
     },
 };
 typeRegistry_1.messageTypeRegistry.set(exports.NavigationState.$type, exports.NavigationState);
-function createBaseGuidanceOrder() {
-    return {
-        $type: "keelson.GuidanceOrder",
-        track: undefined,
-        courseOverGroundDeg: undefined,
-        headingDeg: undefined,
-        hold: undefined,
-        speedKnots: undefined,
-    };
-}
-exports.GuidanceOrder = {
-    $type: "keelson.GuidanceOrder",
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.track !== undefined) {
-            exports.GuidanceOrder_Track.encode(message.track, writer.uint32(10).fork()).join();
-        }
-        if (message.courseOverGroundDeg !== undefined) {
-            writer.uint32(17).double(message.courseOverGroundDeg);
-        }
-        if (message.headingDeg !== undefined) {
-            writer.uint32(25).double(message.headingDeg);
-        }
-        if (message.hold !== undefined) {
-            exports.GuidanceOrder_Hold.encode(message.hold, writer.uint32(34).fork()).join();
-        }
-        if (message.speedKnots !== undefined) {
-            writer.uint32(41).double(message.speedKnots);
-        }
-        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 = createBaseGuidanceOrder();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.track = exports.GuidanceOrder_Track.decode(reader, reader.uint32());
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 17) {
-                        break;
-                    }
-                    message.courseOverGroundDeg = reader.double();
-                    continue;
-                }
-                case 3: {
-                    if (tag !== 25) {
-                        break;
-                    }
-                    message.headingDeg = reader.double();
-                    continue;
-                }
-                case 4: {
-                    if (tag !== 34) {
-                        break;
-                    }
-                    message.hold = exports.GuidanceOrder_Hold.decode(reader, reader.uint32());
-                    continue;
-                }
-                case 5: {
-                    if (tag !== 41) {
-                        break;
-                    }
-                    message.speedKnots = reader.double();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            $type: exports.GuidanceOrder.$type,
-            track: isSet(object.track) ? exports.GuidanceOrder_Track.fromJSON(object.track) : undefined,
-            courseOverGroundDeg: isSet(object.courseOverGroundDeg)
-                ? globalThis.Number(object.courseOverGroundDeg)
-                : undefined,
-            headingDeg: isSet(object.headingDeg) ? globalThis.Number(object.headingDeg) : undefined,
-            hold: isSet(object.hold) ? exports.GuidanceOrder_Hold.fromJSON(object.hold) : undefined,
-            speedKnots: isSet(object.speedKnots) ? globalThis.Number(object.speedKnots) : undefined,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.track !== undefined) {
-            obj.track = exports.GuidanceOrder_Track.toJSON(message.track);
-        }
-        if (message.courseOverGroundDeg !== undefined) {
-            obj.courseOverGroundDeg = message.courseOverGroundDeg;
-        }
-        if (message.headingDeg !== undefined) {
-            obj.headingDeg = message.headingDeg;
-        }
-        if (message.hold !== undefined) {
-            obj.hold = exports.GuidanceOrder_Hold.toJSON(message.hold);
-        }
-        if (message.speedKnots !== undefined) {
-            obj.speedKnots = message.speedKnots;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.GuidanceOrder.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseGuidanceOrder();
-        message.track = (object.track !== undefined && object.track !== null)
-            ? exports.GuidanceOrder_Track.fromPartial(object.track)
-            : undefined;
-        message.courseOverGroundDeg = object.courseOverGroundDeg ?? undefined;
-        message.headingDeg = object.headingDeg ?? undefined;
-        message.hold = (object.hold !== undefined && object.hold !== null)
-            ? exports.GuidanceOrder_Hold.fromPartial(object.hold)
-            : undefined;
-        message.speedKnots = object.speedKnots ?? undefined;
-        return message;
-    },
-};
-typeRegistry_1.messageTypeRegistry.set(exports.GuidanceOrder.$type, exports.GuidanceOrder);
-function createBaseGuidanceOrder_Track() {
-    return { $type: "keelson.GuidanceOrder.Track", resumeFromWaypointId: undefined };
-}
-exports.GuidanceOrder_Track = {
-    $type: "keelson.GuidanceOrder.Track",
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.resumeFromWaypointId !== undefined) {
-            writer.uint32(10).string(message.resumeFromWaypointId);
-        }
-        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 = createBaseGuidanceOrder_Track();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.resumeFromWaypointId = reader.string();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            $type: exports.GuidanceOrder_Track.$type,
-            resumeFromWaypointId: isSet(object.resumeFromWaypointId)
-                ? globalThis.String(object.resumeFromWaypointId)
-                : undefined,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.resumeFromWaypointId !== undefined) {
-            obj.resumeFromWaypointId = message.resumeFromWaypointId;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.GuidanceOrder_Track.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseGuidanceOrder_Track();
-        message.resumeFromWaypointId = object.resumeFromWaypointId ?? undefined;
-        return message;
-    },
-};
-typeRegistry_1.messageTypeRegistry.set(exports.GuidanceOrder_Track.$type, exports.GuidanceOrder_Track);
-function createBaseGuidanceOrder_Hold() {
-    return { $type: "keelson.GuidanceOrder.Hold" };
-}
-exports.GuidanceOrder_Hold = {
-    $type: "keelson.GuidanceOrder.Hold",
-    encode(_, writer = new wire_1.BinaryWriter()) {
-        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 = createBaseGuidanceOrder_Hold();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(_) {
-        return { $type: exports.GuidanceOrder_Hold.$type };
-    },
-    toJSON(_) {
-        const obj = {};
-        return obj;
-    },
-    create(base) {
-        return exports.GuidanceOrder_Hold.fromPartial(base ?? {});
-    },
-    fromPartial(_) {
-        const message = createBaseGuidanceOrder_Hold();
-        return message;
-    },
-};
-typeRegistry_1.messageTypeRegistry.set(exports.GuidanceOrder_Hold.$type, exports.GuidanceOrder_Hold);
 function toTimestamp(date) {
     const seconds = Math.trunc(date.getTime() / 1000);
     const nanos = (date.getTime() % 1000) * 1000000;

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

package/dist/interfaces/NavigationControl.d.ts

@@ -1,169 +0,0 @@
-import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
-import { GuidanceOrder, NavigationState } from "./NavigationState";
-import { RouteRef } from "./Route";
-import { CommandResult } from "./VehicleCommon";
-import { VoyageStatus } from "./Voyage";
-export declare const protobufPackage = "keelson.interfaces.navigation_control";
-/** Who is calling, and on what authority. Carried by every mutating request. */
-export interface Caller {
-    /**
-     * Identity of the operator and site, or the service, e.g. "ted@ROC-1", "slipway". Recorded in
-     * the responder's decision log, so it should mean something to somebody reading that later.
-     */
-    controllerId: string;
-    /**
-     * The token of the command_authority lease the caller holds. Absent when it holds none, which
-     * is valid only while the responder holds the conn itself (see WHO MAY CALL).
-     */
-    authorityToken?: string | undefined;
-}
-/** Make a route edition the active voyage of this vessel. */
-export interface LoadRouteRequest {
-    /** Client wall-clock at send, for latency logging only. */
-    timestamp: Date | undefined;
-    caller: Caller | undefined;
-    /**
-     * The entity whose route tree holds the edition. RouteRef names no entity, so it always
-     * resolves inside the vessel's own tree; a route drawn for another vessel is copied first.
-     * When it differs from this vessel, the responder reads
-     * `{base}/@v0/{source_entity_id}/pubsub/route/{route_id}/edition/{N}` and republishes it
-     * unchanged under its own vessel, with the same route_id and edition, before activating it.
-     * Editions are immutable, so the copy is the same route, not a new one.
-     */
-    sourceEntityId: string;
-    /**
-     * The edition to sail. Never `latest`: an edition that cannot be resolved is refused, never
-     * silently replaced.
-     */
-    routeRef: RouteRef | undefined;
-    /**
-     * The voyage to activate. Absent: the responder mints one. Present and already a voyage of
-     * this vessel: that voyage is re-pinned to `route_ref` (a reroute).
-     */
-    voyageId?: string | undefined;
-    /** The guidance order to take up once the voyage is active. Absent: TRACK. */
-    initialOrder?: GuidanceOrder | undefined;
-}
-export interface LoadRouteResponse {
-    result: CommandResult;
-    /**
-     * Why not, when result is not ACCEPTED: an unresolvable edition, no conn, another voyage the
-     * responder will not displace. Empty otherwise.
-     */
-    detail: string;
-    /** The voyage now ACTIVE, when result is ACCEPTED. */
-    voyageId?: string | undefined;
-    /** The navigation state the order produced. */
-    state?: NavigationState | undefined;
-}
-/** Change how the vessel is steered while a voyage is active. */
-export interface SetGuidanceOrderRequest {
-    timestamp: Date | undefined;
-    caller: Caller | undefined;
-    order: GuidanceOrder | undefined;
-}
-export interface SetGuidanceOrderResponse {
-    /**
-     * UNSUPPORTED when the responder, or the vehicle behind it, cannot hold the requested frame —
-     * it never substitutes course for heading or the reverse.
-     */
-    result: CommandResult;
-    detail: string;
-    state?: NavigationState | undefined;
-}
-/** Pause, resume, complete or abort the active voyage. */
-export interface SetVoyageStatusRequest {
-    timestamp: Date | undefined;
-    caller: Caller | undefined;
-    voyageId: string;
-    /**
-     * PAUSED, ACTIVE (resume), COMPLETED or ABORTED. PLANNED is refused: a voyage is planned by
-     * publishing it, not by asking the process sailing it.
-     */
-    status: VoyageStatus;
-    /** Why, for the voyage's audit trail. Free text. */
-    reason: string;
-}
-export interface SetVoyageStatusResponse {
-    result: CommandResult;
-    detail: string;
-    state?: NavigationState | undefined;
-}
-export interface GetNavigationStateRequest {
-}
-export declare const Caller: MessageFns<Caller>;
-export declare const LoadRouteRequest: MessageFns<LoadRouteRequest>;
-export declare const LoadRouteResponse: MessageFns<LoadRouteResponse>;
-export declare const SetGuidanceOrderRequest: MessageFns<SetGuidanceOrderRequest>;
-export declare const SetGuidanceOrderResponse: MessageFns<SetGuidanceOrderResponse>;
-export declare const SetVoyageStatusRequest: MessageFns<SetVoyageStatusRequest>;
-export declare const SetVoyageStatusResponse: MessageFns<SetVoyageStatusResponse>;
-export declare const GetNavigationStateRequest: MessageFns<GetNavigationStateRequest>;
-export type NavigationControlDefinition = typeof NavigationControlDefinition;
-export declare const NavigationControlDefinition: {
-    readonly name: "NavigationControl";
-    readonly fullName: "keelson.interfaces.navigation_control.NavigationControl";
-    readonly methods: {
-        /**
-         * Make a route edition this vessel's active voyage, copying it from another vessel's tree when
-         * needed, and take up a guidance order.
-         */
-        readonly load_route: {
-            readonly name: "load_route";
-            readonly requestType: MessageFns<LoadRouteRequest>;
-            readonly requestStream: false;
-            readonly responseType: MessageFns<LoadRouteResponse>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
-        /** Steer by the track, a course, a heading, or hold; optionally with a speed. */
-        readonly set_guidance_order: {
-            readonly name: "set_guidance_order";
-            readonly requestType: MessageFns<SetGuidanceOrderRequest>;
-            readonly requestStream: false;
-            readonly responseType: MessageFns<SetGuidanceOrderResponse>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
-        /** Pause, resume, complete or abort the active voyage. */
-        readonly set_voyage_status: {
-            readonly name: "set_voyage_status";
-            readonly requestType: MessageFns<SetVoyageStatusRequest>;
-            readonly requestStream: false;
-            readonly responseType: MessageFns<SetVoyageStatusResponse>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
-        /**
-         * The current NavigationState — the same payload as the `navigation_state` broadcast, for a
-         * caller that cannot wait for the next one. Needs no authority.
-         */
-        readonly get_navigation_state: {
-            readonly name: "get_navigation_state";
-            readonly requestType: MessageFns<GetNavigationStateRequest>;
-            readonly requestStream: false;
-            readonly responseType: import("./NavigationState").MessageFns<NavigationState>;
-            readonly responseStream: false;
-            readonly options: {};
-        };
-    };
-};
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-export 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 keyof T]?: DeepPartial<T[K]>;
-} : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-export 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>>]: never;
-};
-export interface MessageFns<T> {
-    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 {};