@rise-maritime/keelson-js 0.6.0-pre.7 → 0.6.0-pre.9

package/dist/index.d.ts

@@ -183,6 +183,67 @@ export declare function getInterfaceDefinition(interfaceAndVersion: string): {
             readonly options: {};
         };
     };
+} | {
+    readonly name: "ScenarioControl";
+    readonly fullName: "keelson.interfaces.scenario_control.ScenarioControl";
+    readonly methods: {
+        readonly load: {
+            readonly name: "load";
+            readonly requestType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").LoadRequest>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").LoadResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly start: {
+            readonly name: "start";
+            readonly requestType: import("./interfaces/google/protobuf/empty").MessageFns<import("./interfaces/google/protobuf/empty").Empty>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").StartResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly pause: {
+            readonly name: "pause";
+            readonly requestType: import("./interfaces/google/protobuf/empty").MessageFns<import("./interfaces/google/protobuf/empty").Empty>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").PauseResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly stop: {
+            readonly name: "stop";
+            readonly requestType: import("./interfaces/google/protobuf/empty").MessageFns<import("./interfaces/google/protobuf/empty").Empty>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").StopResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly reset: {
+            readonly name: "reset";
+            readonly requestType: import("./interfaces/google/protobuf/empty").MessageFns<import("./interfaces/google/protobuf/empty").Empty>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").ResetResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly step: {
+            readonly name: "step";
+            readonly requestType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").StepRequest>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").StepResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly set_rate: {
+            readonly name: "set_rate";
+            readonly requestType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").SetRateRequest>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ScenarioControl").MessageFns<import("./interfaces/ScenarioControl").SetRateResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+    };
 } | {
     readonly name: "SimulationControl";
     readonly fullName: "keelson.interfaces.simulation_control.SimulationControl";

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 {};