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

package/dist/interfaces/Coordinate.js

@@ -0,0 +1,82 @@
+"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: Coordinate.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Coordinate = exports.protobufPackage = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+exports.protobufPackage = "keelson";
+function createBaseCoordinate() {
+    return { latitudeDeg: 0, longitudeDeg: 0 };
+}
+exports.Coordinate = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.latitudeDeg !== 0) {
+            writer.uint32(9).double(message.latitudeDeg);
+        }
+        if (message.longitudeDeg !== 0) {
+            writer.uint32(17).double(message.longitudeDeg);
+        }
+        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 = createBaseCoordinate();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 9) {
+                        break;
+                    }
+                    message.latitudeDeg = reader.double();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 17) {
+                        break;
+                    }
+                    message.longitudeDeg = reader.double();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            latitudeDeg: isSet(object.latitudeDeg) ? globalThis.Number(object.latitudeDeg) : 0,
+            longitudeDeg: isSet(object.longitudeDeg) ? globalThis.Number(object.longitudeDeg) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.latitudeDeg !== 0) {
+            obj.latitudeDeg = message.latitudeDeg;
+        }
+        if (message.longitudeDeg !== 0) {
+            obj.longitudeDeg = message.longitudeDeg;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Coordinate.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCoordinate();
+        message.latitudeDeg = object.latitudeDeg ?? 0;
+        message.longitudeDeg = object.longitudeDeg ?? 0;
+        return message;
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/interfaces/ErrorResponse.d.ts

@@ -1,5 +1,5 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
-export declare const protobufPackage = "";
+export declare const protobufPackage = "keelson.interfaces";
 export interface ErrorResponse {
     errorDescription: string;
     code: ErrorResponse_Code;

package/dist/interfaces/ErrorResponse.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResponse = exports.errorResponse_CodeToJSON = exports.errorResponse_CodeFromJSON = exports.ErrorResponse_Code = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
-exports.protobufPackage = "";
+exports.protobufPackage = "keelson.interfaces";
 /**
  * Typed code so clients can react without parsing the description.
  * Producers SHOULD emit a specific code when applicable; UNSPECIFIED

package/dist/interfaces/MavlinkCommand.d.ts

@@ -1,6 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { CommandResult } from "./VehicleCommon";
-export declare const protobufPackage = "";
+export declare const protobufPackage = "keelson.interfaces.mavlink_command";
 export interface SetMessageIntervalRequest {
     /**
      * Either the symbolic MAVLink message name (e.g. "ATTITUDE") OR the
@@ -45,23 +45,29 @@ export declare const SetMessageIntervalRequest: MessageFns<SetMessageIntervalReq
 export declare const SetMessageIntervalResponse: MessageFns<SetMessageIntervalResponse>;
 export declare const CommandLongRequest: MessageFns<CommandLongRequest>;
 export declare const CommandLongResponse: MessageFns<CommandLongResponse>;
-export interface MavlinkCommand {
-    set_message_interval(request: SetMessageIntervalRequest): Promise<SetMessageIntervalResponse>;
-    send_command_long(request: CommandLongRequest): Promise<CommandLongResponse>;
-}
-export declare const MavlinkCommandServiceName = "MavlinkCommand";
-export declare class MavlinkCommandClientImpl implements MavlinkCommand {
-    private readonly rpc;
-    private readonly service;
-    constructor(rpc: Rpc, opts?: {
-        service?: string;
-    });
-    set_message_interval(request: SetMessageIntervalRequest): Promise<SetMessageIntervalResponse>;
-    send_command_long(request: CommandLongRequest): Promise<CommandLongResponse>;
-}
-interface Rpc {
-    request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
-}
+export type MavlinkCommandDefinition = typeof MavlinkCommandDefinition;
+export declare const MavlinkCommandDefinition: {
+    readonly name: "MavlinkCommand";
+    readonly fullName: "keelson.interfaces.mavlink_command.MavlinkCommand";
+    readonly methods: {
+        readonly set_message_interval: {
+            readonly name: "set_message_interval";
+            readonly requestType: MessageFns<SetMessageIntervalRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<SetMessageIntervalResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly send_command_long: {
+            readonly name: "send_command_long";
+            readonly requestType: MessageFns<CommandLongRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<CommandLongResponse>;
+            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]>;

package/dist/interfaces/MavlinkCommand.js

@@ -5,11 +5,11 @@
 //   protoc               v6.30.2
 // source: MavlinkCommand.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MavlinkCommandClientImpl = exports.MavlinkCommandServiceName = exports.CommandLongResponse = exports.CommandLongRequest = exports.SetMessageIntervalResponse = exports.SetMessageIntervalRequest = exports.protobufPackage = void 0;
+exports.MavlinkCommandDefinition = exports.CommandLongResponse = exports.CommandLongRequest = exports.SetMessageIntervalResponse = exports.SetMessageIntervalRequest = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const VehicleCommon_1 = require("./VehicleCommon");
-exports.protobufPackage = "";
+exports.protobufPackage = "keelson.interfaces.mavlink_command";
 function createBaseSetMessageIntervalRequest() {
     return { messageName: "", messageId: 0, hz: 0 };
 }
@@ -442,26 +442,28 @@ exports.CommandLongResponse = {
         return message;
     },
 };
-exports.MavlinkCommandServiceName = "MavlinkCommand";
-class MavlinkCommandClientImpl {
-    constructor(rpc, opts) {
-        this.service = opts?.service || exports.MavlinkCommandServiceName;
-        this.rpc = rpc;
-        this.set_message_interval = this.set_message_interval.bind(this);
-        this.send_command_long = this.send_command_long.bind(this);
-    }
-    set_message_interval(request) {
-        const data = exports.SetMessageIntervalRequest.encode(request).finish();
-        const promise = this.rpc.request(this.service, "set_message_interval", data);
-        return promise.then((data) => exports.SetMessageIntervalResponse.decode(new wire_1.BinaryReader(data)));
-    }
-    send_command_long(request) {
-        const data = exports.CommandLongRequest.encode(request).finish();
-        const promise = this.rpc.request(this.service, "send_command_long", data);
-        return promise.then((data) => exports.CommandLongResponse.decode(new wire_1.BinaryReader(data)));
-    }
-}
-exports.MavlinkCommandClientImpl = MavlinkCommandClientImpl;
+exports.MavlinkCommandDefinition = {
+    name: "MavlinkCommand",
+    fullName: "keelson.interfaces.mavlink_command.MavlinkCommand",
+    methods: {
+        set_message_interval: {
+            name: "set_message_interval",
+            requestType: exports.SetMessageIntervalRequest,
+            requestStream: false,
+            responseType: exports.SetMessageIntervalResponse,
+            responseStream: false,
+            options: {},
+        },
+        send_command_long: {
+            name: "send_command_long",
+            requestType: exports.CommandLongRequest,
+            requestStream: false,
+            responseType: exports.CommandLongResponse,
+            responseStream: false,
+            options: {},
+        },
+    },
+};
 function isSet(value) {
     return value !== null && value !== undefined;
 }

package/dist/interfaces/Mission.d.ts

@@ -0,0 +1,128 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { Coordinate } from "./Coordinate";
+import { Empty } from "./google/protobuf/empty";
+export declare const protobufPackage = "keelson";
+/**
+ * One step in a mission. The `step` oneof picks the action; fields
+ * that don't apply to the chosen step are simply absent (no opaque
+ * `param1..4` carrying overloaded meanings).
+ *
+ * Sequence position is the index in Mission.items — there is no
+ * separate `seq` field. Connectors that need wire-level sequence
+ * numbers (e.g. MAVLink MISSION_ITEM_INT) synthesise them from the
+ * list index on upload. A MissionItem published in isolation loses
+ * that context; publishing designs must carry it explicitly (index,
+ * mission id, ...).
+ */
+export interface MissionItem {
+    autocontinue: boolean;
+    waypoint?: MissionWaypoint | undefined;
+    loiter?: Loiter | undefined;
+    delay?: Delay | undefined;
+    returnHome?: ReturnHome | undefined;
+    changeSpeed?: ChangeSpeed | undefined;
+    setHome?: SetHome | undefined;
+}
+export interface Mission {
+    items: MissionItem[];
+}
+/**
+ * Drive to a position and (optionally) hold for a fixed duration before
+ * proceeding. `altitude_m` is interpreted per the connector's vehicle
+ * type (surface vessels typically use 0). `acceptance_radius_m = 0`
+ * means "use the autopilot's default".
+ *
+ * Named `MissionWaypoint`, not `Waypoint`: `keelson.Waypoint` is the route
+ * plan artifact in Route.proto — stable id, revision, turn radius,
+ * wheel-over distance, operational context, outgoing leg. The two are not
+ * two spellings of one concept and merging them would produce a union that
+ * serves neither; see protocol-specification.md §6.8. What converges
+ * between them is `Coordinate`, which both now use for position.
+ */
+export interface MissionWaypoint {
+    position: Coordinate | undefined;
+    altitudeM: number;
+    acceptanceRadiusM: number;
+    /**
+     * Hold at the waypoint for this many seconds before advancing.
+     * 0 = pass straight through.
+     */
+    holdTimeS: number;
+}
+/** Orbit a position. Termination picks how the loiter ends. */
+export interface Loiter {
+    position: Coordinate | undefined;
+    altitudeM: number;
+    radiusM: number;
+    /** loiter forever */
+    unlimited?: Empty | undefined;
+    /** loiter for N complete orbits */
+    turns?: number | undefined;
+    /** loiter for this many seconds */
+    durationS?: number | undefined;
+}
+/** Wait in place for a fixed duration before advancing. */
+export interface Delay {
+    durationS: number;
+}
+/** Return to the launch / home position. */
+export interface ReturnHome {
+}
+/** Change the cruise speed used by subsequent waypoints. */
+export interface ChangeSpeed {
+    speedMps: number;
+}
+/** Update the vehicle's home position to a specific coordinate. */
+export interface SetHome {
+    position: Coordinate | undefined;
+    altitudeM: number;
+}
+/**
+ * The mission step the autopilot is currently executing, resolved and
+ * published as state (subject `current_mission_item`). Carries the
+ * context a bare MissionItem lacks: its position in the mission (`seq`,
+ * the index into Mission.items) and the mission length. Published by
+ * connectors that hold the active mission (from upload/download);
+ * state republication, not a derived value — resolving it requires RPC
+ * state no subject carries.
+ */
+export interface CurrentMissionItem {
+    timestamp: Date | undefined;
+    /**
+     * Index of `item` in the active mission (wire seq numbering, matching
+     * upload/download order).
+     */
+    seq: number;
+    /** Number of items in the active mission. */
+    totalItems: number;
+    /** The resolved step at `seq`. */
+    item: MissionItem | undefined;
+}
+export declare const MissionItem: MessageFns<MissionItem>;
+export declare const Mission: MessageFns<Mission>;
+export declare const MissionWaypoint: MessageFns<MissionWaypoint>;
+export declare const Loiter: MessageFns<Loiter>;
+export declare const Delay: MessageFns<Delay>;
+export declare const ReturnHome: MessageFns<ReturnHome>;
+export declare const ChangeSpeed: MessageFns<ChangeSpeed>;
+export declare const SetHome: MessageFns<SetHome>;
+export declare const CurrentMissionItem: MessageFns<CurrentMissionItem>;
+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 {};