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

package/dist/interfaces/ScenarioControl.d.ts

@@ -0,0 +1,144 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { Empty } from "./google/protobuf/empty";
+export declare const protobufPackage = "keelson.interfaces.scenario_control";
+export interface LoadRequest {
+    /**
+     * Identifier of the scenario to load, as the responder understands it —
+     * an id within a configured library, or a path it can resolve. Left
+     * deliberately opaque: what a scenario *is* varies by simulator, and
+     * pinning a schema here would bind every implementation to one.
+     */
+    scenario: string;
+}
+export interface StepRequest {
+    /**
+     * Number of fixed steps to advance. Zero is a no-op that still replies
+     * OK, so a caller can poll the resulting tick without special-casing.
+     */
+    ticks: number;
+}
+export interface SetRateRequest {
+    /**
+     * Wall-clock scaling of simulated time. 1.0 is real time, 0.0 is
+     * unpaced; negative replies OUT_OF_RANGE.
+     */
+    rate: number;
+}
+/**
+ * One response message per RPC. Each is dedicated to its method so an
+ * individual command can grow a return field later without a breaking
+ * type change and without that field bleeding onto the other commands.
+ */
+export interface LoadResponse {
+}
+export interface StartResponse {
+}
+export interface PauseResponse {
+}
+export interface StopResponse {
+}
+export interface ResetResponse {
+}
+export interface SetRateResponse {
+}
+export interface StepResponse {
+    /**
+     * Where the clock came to rest. Returned rather than left to the status
+     * broadcast because the caller of a deterministic step needs to know
+     * which tick it just produced, without racing a 1 Hz status sample.
+     */
+    tick: number;
+    simulationTime: Date | undefined;
+}
+export declare const LoadRequest: MessageFns<LoadRequest>;
+export declare const StepRequest: MessageFns<StepRequest>;
+export declare const SetRateRequest: MessageFns<SetRateRequest>;
+export declare const LoadResponse: MessageFns<LoadResponse>;
+export declare const StartResponse: MessageFns<StartResponse>;
+export declare const PauseResponse: MessageFns<PauseResponse>;
+export declare const StopResponse: MessageFns<StopResponse>;
+export declare const ResetResponse: MessageFns<ResetResponse>;
+export declare const SetRateResponse: MessageFns<SetRateResponse>;
+export declare const StepResponse: MessageFns<StepResponse>;
+export type ScenarioControlDefinition = typeof ScenarioControlDefinition;
+export declare const ScenarioControlDefinition: {
+    readonly name: "ScenarioControl";
+    readonly fullName: "keelson.interfaces.scenario_control.ScenarioControl";
+    readonly methods: {
+        readonly load: {
+            readonly name: "load";
+            readonly requestType: MessageFns<LoadRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<LoadResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly start: {
+            readonly name: "start";
+            readonly requestType: import("./google/protobuf/empty").MessageFns<Empty>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StartResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly pause: {
+            readonly name: "pause";
+            readonly requestType: import("./google/protobuf/empty").MessageFns<Empty>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<PauseResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly stop: {
+            readonly name: "stop";
+            readonly requestType: import("./google/protobuf/empty").MessageFns<Empty>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StopResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly reset: {
+            readonly name: "reset";
+            readonly requestType: import("./google/protobuf/empty").MessageFns<Empty>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<ResetResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly step: {
+            readonly name: "step";
+            readonly requestType: MessageFns<StepRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StepResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly set_rate: {
+            readonly name: "set_rate";
+            readonly requestType: MessageFns<SetRateRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<SetRateResponse>;
+            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 {};

package/dist/interfaces/ScenarioControl.js

@@ -0,0 +1,552 @@
+"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: ScenarioControl.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+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 createBaseLoadRequest() {
+    return { scenario: "" };
+}
+exports.LoadRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.scenario !== "") {
+            writer.uint32(10).string(message.scenario);
+        }
+        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 = createBaseLoadRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.scenario = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { scenario: isSet(object.scenario) ? globalThis.String(object.scenario) : "" };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.scenario !== "") {
+            obj.scenario = message.scenario;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.LoadRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseLoadRequest();
+        message.scenario = object.scenario ?? "";
+        return message;
+    },
+};
+function createBaseStepRequest() {
+    return { ticks: 0 };
+}
+exports.StepRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.ticks !== 0) {
+            writer.uint32(8).uint32(message.ticks);
+        }
+        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 = createBaseStepRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.ticks = reader.uint32();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { ticks: isSet(object.ticks) ? globalThis.Number(object.ticks) : 0 };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.ticks !== 0) {
+            obj.ticks = Math.round(message.ticks);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.StepRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseStepRequest();
+        message.ticks = object.ticks ?? 0;
+        return message;
+    },
+};
+function createBaseSetRateRequest() {
+    return { rate: 0 };
+}
+exports.SetRateRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.rate !== 0) {
+            writer.uint32(9).double(message.rate);
+        }
+        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 = createBaseSetRateRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 9) {
+                        break;
+                    }
+                    message.rate = reader.double();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { rate: isSet(object.rate) ? globalThis.Number(object.rate) : 0 };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.rate !== 0) {
+            obj.rate = message.rate;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SetRateRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetRateRequest();
+        message.rate = object.rate ?? 0;
+        return message;
+    },
+};
+function createBaseLoadResponse() {
+    return {};
+}
+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 = createBaseLoadResponse();
+        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 {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.LoadResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseLoadResponse();
+        return message;
+    },
+};
+function createBaseStartResponse() {
+    return {};
+}
+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 = createBaseStartResponse();
+        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 {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.StartResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseStartResponse();
+        return message;
+    },
+};
+function createBasePauseResponse() {
+    return {};
+}
+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 = createBasePauseResponse();
+        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 {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.PauseResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBasePauseResponse();
+        return message;
+    },
+};
+function createBaseStopResponse() {
+    return {};
+}
+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 = createBaseStopResponse();
+        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 {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.StopResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseStopResponse();
+        return message;
+    },
+};
+function createBaseResetResponse() {
+    return {};
+}
+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 = createBaseResetResponse();
+        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 {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.ResetResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseResetResponse();
+        return message;
+    },
+};
+function createBaseSetRateResponse() {
+    return {};
+}
+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 = createBaseSetRateResponse();
+        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 {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.SetRateResponse.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseSetRateResponse();
+        return message;
+    },
+};
+function createBaseStepResponse() {
+    return { tick: 0, simulationTime: undefined };
+}
+exports.StepResponse = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.tick !== 0) {
+            writer.uint32(8).uint64(message.tick);
+        }
+        if (message.simulationTime !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.simulationTime), writer.uint32(18).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 = createBaseStepResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.tick = longToNumber(reader.uint64());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.simulationTime = 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 {
+            tick: isSet(object.tick) ? globalThis.Number(object.tick) : 0,
+            simulationTime: isSet(object.simulationTime) ? fromJsonTimestamp(object.simulationTime) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.tick !== 0) {
+            obj.tick = Math.round(message.tick);
+        }
+        if (message.simulationTime !== undefined) {
+            obj.simulationTime = message.simulationTime.toISOString();
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.StepResponse.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseStepResponse();
+        message.tick = object.tick ?? 0;
+        message.simulationTime = object.simulationTime ?? undefined;
+        return message;
+    },
+};
+exports.ScenarioControlDefinition = {
+    name: "ScenarioControl",
+    fullName: "keelson.interfaces.scenario_control.ScenarioControl",
+    methods: {
+        load: {
+            name: "load",
+            requestType: exports.LoadRequest,
+            requestStream: false,
+            responseType: exports.LoadResponse,
+            responseStream: false,
+            options: {},
+        },
+        start: {
+            name: "start",
+            requestType: empty_1.Empty,
+            requestStream: false,
+            responseType: exports.StartResponse,
+            responseStream: false,
+            options: {},
+        },
+        pause: {
+            name: "pause",
+            requestType: empty_1.Empty,
+            requestStream: false,
+            responseType: exports.PauseResponse,
+            responseStream: false,
+            options: {},
+        },
+        stop: {
+            name: "stop",
+            requestType: empty_1.Empty,
+            requestStream: false,
+            responseType: exports.StopResponse,
+            responseStream: false,
+            options: {},
+        },
+        reset: {
+            name: "reset",
+            requestType: empty_1.Empty,
+            requestStream: false,
+            responseType: exports.ResetResponse,
+            responseStream: false,
+            options: {},
+        },
+        step: {
+            name: "step",
+            requestType: exports.StepRequest,
+            requestStream: false,
+            responseType: exports.StepResponse,
+            responseStream: false,
+            options: {},
+        },
+        set_rate: {
+            name: "set_rate",
+            requestType: exports.SetRateRequest,
+            requestStream: false,
+            responseType: exports.SetRateResponse,
+            responseStream: false,
+            options: {},
+        },
+    },
+};
+function toTimestamp(date) {
+    const seconds = Math.trunc(date.getTime() / 1000);
+    const nanos = (date.getTime() % 1000) * 1000000;
+    return { 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 longToNumber(int64) {
+    const num = globalThis.Number(int64.toString());
+    if (num > globalThis.Number.MAX_SAFE_INTEGER) {
+        throw new globalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");
+    }
+    if (num < globalThis.Number.MIN_SAFE_INTEGER) {
+        throw new globalThis.Error("Value is smaller than Number.MIN_SAFE_INTEGER");
+    }
+    return num;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}