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

package/dist/interfaces/ScenarioControl.js

@@ -5,315 +5,12 @@
 //   protoc               v6.30.2
 // source: ScenarioControl.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScenarioControlDefinition = exports.StepResponse = exports.LoadResponse = exports.SetRateResponse = exports.ResetResponse = exports.StopResponse = exports.PauseResponse = exports.StartResponse = exports.SetRateRequest = exports.StepRequest = exports.LoadRequest = exports.ListResponse = exports.ListRequest = exports.ScenarioInfo = exports.protobufPackage = void 0;
+exports.ScenarioControlDefinition = exports.StepResponse = exports.SetRateResponse = exports.ResetResponse = exports.StopResponse = exports.PauseResponse = exports.StartResponse = exports.LoadResponse = exports.SetRateRequest = exports.StepRequest = exports.LoadRequest = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const empty_1 = require("./google/protobuf/empty");
 const timestamp_1 = require("./google/protobuf/timestamp");
 exports.protobufPackage = "keelson.interfaces.scenario_control";
-function createBaseScenarioInfo() {
-    return {
-        scenarioId: "",
-        description: "",
-        scenarioHash: "",
-        vesselCount: 0,
-        durationTicks: 0,
-        stepSizeMs: 0,
-        loadable: false,
-        reason: "",
-    };
-}
-exports.ScenarioInfo = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.scenarioId !== "") {
-            writer.uint32(10).string(message.scenarioId);
-        }
-        if (message.description !== "") {
-            writer.uint32(18).string(message.description);
-        }
-        if (message.scenarioHash !== "") {
-            writer.uint32(26).string(message.scenarioHash);
-        }
-        if (message.vesselCount !== 0) {
-            writer.uint32(32).uint32(message.vesselCount);
-        }
-        if (message.durationTicks !== 0) {
-            writer.uint32(40).uint64(message.durationTicks);
-        }
-        if (message.stepSizeMs !== 0) {
-            writer.uint32(48).uint32(message.stepSizeMs);
-        }
-        if (message.loadable !== false) {
-            writer.uint32(56).bool(message.loadable);
-        }
-        if (message.reason !== "") {
-            writer.uint32(66).string(message.reason);
-        }
-        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 = createBaseScenarioInfo();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.scenarioId = reader.string();
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 18) {
-                        break;
-                    }
-                    message.description = reader.string();
-                    continue;
-                }
-                case 3: {
-                    if (tag !== 26) {
-                        break;
-                    }
-                    message.scenarioHash = reader.string();
-                    continue;
-                }
-                case 4: {
-                    if (tag !== 32) {
-                        break;
-                    }
-                    message.vesselCount = reader.uint32();
-                    continue;
-                }
-                case 5: {
-                    if (tag !== 40) {
-                        break;
-                    }
-                    message.durationTicks = longToNumber(reader.uint64());
-                    continue;
-                }
-                case 6: {
-                    if (tag !== 48) {
-                        break;
-                    }
-                    message.stepSizeMs = reader.uint32();
-                    continue;
-                }
-                case 7: {
-                    if (tag !== 56) {
-                        break;
-                    }
-                    message.loadable = reader.bool();
-                    continue;
-                }
-                case 8: {
-                    if (tag !== 66) {
-                        break;
-                    }
-                    message.reason = reader.string();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            scenarioId: isSet(object.scenarioId) ? globalThis.String(object.scenarioId) : "",
-            description: isSet(object.description) ? globalThis.String(object.description) : "",
-            scenarioHash: isSet(object.scenarioHash) ? globalThis.String(object.scenarioHash) : "",
-            vesselCount: isSet(object.vesselCount) ? globalThis.Number(object.vesselCount) : 0,
-            durationTicks: isSet(object.durationTicks) ? globalThis.Number(object.durationTicks) : 0,
-            stepSizeMs: isSet(object.stepSizeMs) ? globalThis.Number(object.stepSizeMs) : 0,
-            loadable: isSet(object.loadable) ? globalThis.Boolean(object.loadable) : false,
-            reason: isSet(object.reason) ? globalThis.String(object.reason) : "",
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.scenarioId !== "") {
-            obj.scenarioId = message.scenarioId;
-        }
-        if (message.description !== "") {
-            obj.description = message.description;
-        }
-        if (message.scenarioHash !== "") {
-            obj.scenarioHash = message.scenarioHash;
-        }
-        if (message.vesselCount !== 0) {
-            obj.vesselCount = Math.round(message.vesselCount);
-        }
-        if (message.durationTicks !== 0) {
-            obj.durationTicks = Math.round(message.durationTicks);
-        }
-        if (message.stepSizeMs !== 0) {
-            obj.stepSizeMs = Math.round(message.stepSizeMs);
-        }
-        if (message.loadable !== false) {
-            obj.loadable = message.loadable;
-        }
-        if (message.reason !== "") {
-            obj.reason = message.reason;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.ScenarioInfo.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseScenarioInfo();
-        message.scenarioId = object.scenarioId ?? "";
-        message.description = object.description ?? "";
-        message.scenarioHash = object.scenarioHash ?? "";
-        message.vesselCount = object.vesselCount ?? 0;
-        message.durationTicks = object.durationTicks ?? 0;
-        message.stepSizeMs = object.stepSizeMs ?? 0;
-        message.loadable = object.loadable ?? false;
-        message.reason = object.reason ?? "";
-        return message;
-    },
-};
-function createBaseListRequest() {
-    return { pattern: "" };
-}
-exports.ListRequest = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.pattern !== "") {
-            writer.uint32(10).string(message.pattern);
-        }
-        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 = createBaseListRequest();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.pattern = reader.string();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return { pattern: isSet(object.pattern) ? globalThis.String(object.pattern) : "" };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.pattern !== "") {
-            obj.pattern = message.pattern;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.ListRequest.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseListRequest();
-        message.pattern = object.pattern ?? "";
-        return message;
-    },
-};
-function createBaseListResponse() {
-    return { baseDirectory: "", scenarios: [], truncated: false };
-}
-exports.ListResponse = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.baseDirectory !== "") {
-            writer.uint32(10).string(message.baseDirectory);
-        }
-        for (const v of message.scenarios) {
-            exports.ScenarioInfo.encode(v, writer.uint32(18).fork()).join();
-        }
-        if (message.truncated !== false) {
-            writer.uint32(24).bool(message.truncated);
-        }
-        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 = createBaseListResponse();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.baseDirectory = reader.string();
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 18) {
-                        break;
-                    }
-                    message.scenarios.push(exports.ScenarioInfo.decode(reader, reader.uint32()));
-                    continue;
-                }
-                case 3: {
-                    if (tag !== 24) {
-                        break;
-                    }
-                    message.truncated = reader.bool();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            baseDirectory: isSet(object.baseDirectory) ? globalThis.String(object.baseDirectory) : "",
-            scenarios: globalThis.Array.isArray(object?.scenarios)
-                ? object.scenarios.map((e) => exports.ScenarioInfo.fromJSON(e))
-                : [],
-            truncated: isSet(object.truncated) ? globalThis.Boolean(object.truncated) : false,
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.baseDirectory !== "") {
-            obj.baseDirectory = message.baseDirectory;
-        }
-        if (message.scenarios?.length) {
-            obj.scenarios = message.scenarios.map((e) => exports.ScenarioInfo.toJSON(e));
-        }
-        if (message.truncated !== false) {
-            obj.truncated = message.truncated;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.ListResponse.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseListResponse();
-        message.baseDirectory = object.baseDirectory ?? "";
-        message.scenarios = object.scenarios?.map((e) => exports.ScenarioInfo.fromPartial(e)) || [];
-        message.truncated = object.truncated ?? false;
-        return message;
-    },
-};
 function createBaseLoadRequest() {
     return { scenario: "" };
 }
@@ -467,17 +164,17 @@ exports.SetRateRequest = {
         return message;
     },
 };
-function createBaseStartResponse() {
+function createBaseLoadResponse() {
     return {};
 }
-exports.StartResponse = {
+exports.LoadResponse = {
     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 = createBaseStartResponse();
+        const message = createBaseLoadResponse();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -497,24 +194,24 @@ exports.StartResponse = {
         return obj;
     },
     create(base) {
-        return exports.StartResponse.fromPartial(base ?? {});
+        return exports.LoadResponse.fromPartial(base ?? {});
     },
     fromPartial(_) {
-        const message = createBaseStartResponse();
+        const message = createBaseLoadResponse();
         return message;
     },
 };
-function createBasePauseResponse() {
+function createBaseStartResponse() {
     return {};
 }
-exports.PauseResponse = {
+exports.StartResponse = {
     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 = createBasePauseResponse();
+        const message = createBaseStartResponse();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -534,24 +231,24 @@ exports.PauseResponse = {
         return obj;
     },
     create(base) {
-        return exports.PauseResponse.fromPartial(base ?? {});
+        return exports.StartResponse.fromPartial(base ?? {});
     },
     fromPartial(_) {
-        const message = createBasePauseResponse();
+        const message = createBaseStartResponse();
         return message;
     },
 };
-function createBaseStopResponse() {
+function createBasePauseResponse() {
     return {};
 }
-exports.StopResponse = {
+exports.PauseResponse = {
     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 = createBaseStopResponse();
+        const message = createBasePauseResponse();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -571,24 +268,24 @@ exports.StopResponse = {
         return obj;
     },
     create(base) {
-        return exports.StopResponse.fromPartial(base ?? {});
+        return exports.PauseResponse.fromPartial(base ?? {});
     },
     fromPartial(_) {
-        const message = createBaseStopResponse();
+        const message = createBasePauseResponse();
         return message;
     },
 };
-function createBaseResetResponse() {
+function createBaseStopResponse() {
     return {};
 }
-exports.ResetResponse = {
+exports.StopResponse = {
     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 = createBaseResetResponse();
+        const message = createBaseStopResponse();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -608,24 +305,24 @@ exports.ResetResponse = {
         return obj;
     },
     create(base) {
-        return exports.ResetResponse.fromPartial(base ?? {});
+        return exports.StopResponse.fromPartial(base ?? {});
     },
     fromPartial(_) {
-        const message = createBaseResetResponse();
+        const message = createBaseStopResponse();
         return message;
     },
 };
-function createBaseSetRateResponse() {
+function createBaseResetResponse() {
     return {};
 }
-exports.SetRateResponse = {
+exports.ResetResponse = {
     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 = createBaseSetRateResponse();
+        const message = createBaseResetResponse();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -645,57 +342,27 @@ exports.SetRateResponse = {
         return obj;
     },
     create(base) {
-        return exports.SetRateResponse.fromPartial(base ?? {});
+        return exports.ResetResponse.fromPartial(base ?? {});
     },
     fromPartial(_) {
-        const message = createBaseSetRateResponse();
+        const message = createBaseResetResponse();
         return message;
     },
 };
-function createBaseLoadResponse() {
-    return { scenarioId: "", scenarioHash: "", runId: "" };
+function createBaseSetRateResponse() {
+    return {};
 }
-exports.LoadResponse = {
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.scenarioId !== "") {
-            writer.uint32(10).string(message.scenarioId);
-        }
-        if (message.scenarioHash !== "") {
-            writer.uint32(18).string(message.scenarioHash);
-        }
-        if (message.runId !== "") {
-            writer.uint32(26).string(message.runId);
-        }
+exports.SetRateResponse = {
+    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 = createBaseLoadResponse();
+        const message = createBaseSetRateResponse();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.scenarioId = reader.string();
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 18) {
-                        break;
-                    }
-                    message.scenarioHash = reader.string();
-                    continue;
-                }
-                case 3: {
-                    if (tag !== 26) {
-                        break;
-                    }
-                    message.runId = reader.string();
-                    continue;
-                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -704,34 +371,18 @@ exports.LoadResponse = {
         }
         return message;
     },
-    fromJSON(object) {
-        return {
-            scenarioId: isSet(object.scenarioId) ? globalThis.String(object.scenarioId) : "",
-            scenarioHash: isSet(object.scenarioHash) ? globalThis.String(object.scenarioHash) : "",
-            runId: isSet(object.runId) ? globalThis.String(object.runId) : "",
-        };
+    fromJSON(_) {
+        return {};
     },
-    toJSON(message) {
+    toJSON(_) {
         const obj = {};
-        if (message.scenarioId !== "") {
-            obj.scenarioId = message.scenarioId;
-        }
-        if (message.scenarioHash !== "") {
-            obj.scenarioHash = message.scenarioHash;
-        }
-        if (message.runId !== "") {
-            obj.runId = message.runId;
-        }
         return obj;
     },
     create(base) {
-        return exports.LoadResponse.fromPartial(base ?? {});
+        return exports.SetRateResponse.fromPartial(base ?? {});
     },
-    fromPartial(object) {
-        const message = createBaseLoadResponse();
-        message.scenarioId = object.scenarioId ?? "";
-        message.scenarioHash = object.scenarioHash ?? "";
-        message.runId = object.runId ?? "";
+    fromPartial(_) {
+        const message = createBaseSetRateResponse();
         return message;
     },
 };
@@ -807,14 +458,6 @@ exports.ScenarioControlDefinition = {
     name: "ScenarioControl",
     fullName: "keelson.interfaces.scenario_control.ScenarioControl",
     methods: {
-        list: {
-            name: "list",
-            requestType: exports.ListRequest,
-            requestStream: false,
-            responseType: exports.ListResponse,
-            responseStream: false,
-            options: {},
-        },
         load: {
             name: "load",
             requestType: exports.LoadRequest,

package/dist/interfaces/VehicleSimulatorControl.d.ts

@@ -15,8 +15,76 @@ export interface InitialPose {
  */
 export interface SetInitialPoseResponse {
 }
+/**
+ * How a vehicle is told to steer. The frame is the field rather than a
+ * separate discriminator, so an order cannot name one frame and carry a
+ * value meant for another.
+ *
+ * The two are different instructions, not two spellings of one. A course
+ * over ground is made good against the water that is moving the hull; a
+ * heading is where she points, and in any current the two differ by the
+ * drift angle. A simulator that treats them alike is wrong by that angle
+ * and says nothing about it.
+ */
+export interface SteeringOrder {
+    /** Make good this course, degrees true, [0, 360). */
+    courseOverGroundDeg?: number | undefined;
+    /**
+     * Point this way, degrees true, [0, 360). What she makes good is then
+     * whatever the water leaves her.
+     */
+    headingDeg?: number | undefined;
+}
+/**
+ * How a vehicle is told to drive. Four frames, in decreasing order of what
+ * the vehicle is asked to guarantee: a speed over the ground is a promise
+ * about the track, a speed through the water is a promise about the hull,
+ * and the last two are machinery settings that promise nothing about
+ * either — what they produce is the vehicle's business.
+ */
+export interface PropulsionOrder {
+    /**
+     * Make good this speed over the ground, m/s. Not always reachable: in
+     * a stream that beats her, the vehicle makes its best and the
+     * shortfall is what the recording shows.
+     */
+    sogMps?: number | undefined;
+    /** This speed through the water, m/s. */
+    stwMps?: number | undefined;
+    /**
+     * A throttle setting, percent. Negative is astern where the vehicle
+     * has it; a vehicle that cannot go astern replies OUT_OF_RANGE rather
+     * than clamping silently.
+     */
+    enginePct?: number | undefined;
+    /** Shaft revolutions per minute. Signed, as engine_pct is. */
+    shaftRpm?: number | undefined;
+}
+/**
+ * A standing order: what the vehicle should be doing until told otherwise.
+ *
+ * Both halves are optional and omitting one leaves it as it is, so a course
+ * can be changed without disturbing a speed. Sending neither is an error
+ * rather than a no-op: it is almost always a caller that failed to set the
+ * field it meant to.
+ */
+export interface StandingOrder {
+    steering: SteeringOrder | undefined;
+    propulsion: PropulsionOrder | undefined;
+}
+/**
+ * Dedicated response for the same reason SetInitialPoseResponse is one: an
+ * order that was accepted but modified — clamped to a limit the vehicle
+ * declares — is a plausible thing to want to return later.
+ */
+export interface SetStandingOrderResponse {
+}
 export declare const InitialPose: MessageFns<InitialPose>;
 export declare const SetInitialPoseResponse: MessageFns<SetInitialPoseResponse>;
+export declare const SteeringOrder: MessageFns<SteeringOrder>;
+export declare const PropulsionOrder: MessageFns<PropulsionOrder>;
+export declare const StandingOrder: MessageFns<StandingOrder>;
+export declare const SetStandingOrderResponse: MessageFns<SetStandingOrderResponse>;
 export type VehicleSimulatorControlDefinition = typeof VehicleSimulatorControlDefinition;
 export declare const VehicleSimulatorControlDefinition: {
     readonly name: "VehicleSimulatorControl";
@@ -34,6 +102,21 @@ export declare const VehicleSimulatorControlDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        /**
+         * Give a RUNNING entity a new standing order, without moving it. On a
+         * STOPPED or ASSIGNED entity, replies ErrorResponse{code =
+         * INVALID_STATE} — the mirror of set_initial_pose's own rule, and for
+         * the same reason: an order to a vehicle that is not going anywhere is
+         * a caller confusing setup with command.
+         */
+        readonly set_standing_order: {
+            readonly name: "set_standing_order";
+            readonly requestType: MessageFns<StandingOrder>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<SetStandingOrderResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;