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

package/dist/payloads/index.keelson.js

@@ -40,9 +40,7 @@ __exportStar(require("./Route"), exports);
 __exportStar(require("./RouteChangeEvent"), exports);
 __exportStar(require("./RouteEditAuthority"), exports);
 __exportStar(require("./RouteExecution"), exports);
-__exportStar(require("./ScenarioEvent"), exports);
 __exportStar(require("./ScenarioStatus"), exports);
-__exportStar(require("./ScenarioTickAck"), exports);
 __exportStar(require("./SensorStatus"), exports);
 __exportStar(require("./SimulationStatus"), exports);
 __exportStar(require("./TargetType"), exports);

package/dist/qos.json

@@ -24,12 +24,6 @@
             "reliability": "RELIABLE",
             "express": false
         },
-        "guaranteed": {
-            "priority": "DATA_HIGH",
-            "congestion_control": "BLOCK",
-            "reliability": "RELIABLE",
-            "express": false
-        },
         "background": {
             "priority": "DATA_LOW",
             "congestion_control": "DROP",
@@ -52,8 +46,6 @@
         "dpad_y_pct": "realtime",
         "wheel_position_pct": "realtime",
         "lever_position_pct": "realtime",
-        "scenario_tick_ack": "guaranteed",
-        "scenario_event": "guaranteed",
         "image_raw": "transient",
         "image_compressed": "transient",
         "video_compressed": "transient",
@@ -80,6 +72,9 @@
         "target_bcr_m": "elevated",
         "target_bct_s": "elevated",
         "weather_alert": "elevated",
+        "depth_below_transducer_m": "elevated",
+        "depth_below_keel_m": "elevated",
+        "depth_below_surface_m": "elevated",
         "route_status": "elevated",
         "route_execution": "elevated",
         "route_edit_authority": "elevated",

package/dist/subjects.json

@@ -10,8 +10,6 @@
     "sensor_status": "keelson.SensorStatus",
     "network_status": "keelson.NetworkStatus",
     "scenario_status": "keelson.ScenarioStatus",
-    "scenario_event": "keelson.ScenarioEvent",
-    "scenario_tick_ack": "keelson.ScenarioTickAck",
     "simulation_status": "keelson.SimulationStatus",
     "roc_status": "keelson.ROCStatus",
     "operational_authority": "keelson.OperationalAuthority",
@@ -108,9 +106,13 @@
     "air_relative_humidity_pct": "keelson.TimestampedFloat",
     "air_pressure_pa": "keelson.TimestampedFloat",
     "dew_point_celsius": "keelson.TimestampedFloat",
+    "illuminance_lux": "keelson.TimestampedFloat",
     "water_temperature_celsius": "keelson.TimestampedFloat",
     "water_salinity_ppt": "keelson.TimestampedFloat",
     "water_speed_of_sound_mps": "keelson.TimestampedFloat",
+    "depth_below_transducer_m": "keelson.TimestampedFloat",
+    "depth_below_keel_m": "keelson.TimestampedFloat",
+    "depth_below_surface_m": "keelson.TimestampedFloat",
     "true_wind_direction_deg": "keelson.TimestampedFloat",
     "true_wind_angle_deg": "keelson.TimestampedFloat",
     "true_wind_speed_mps": "keelson.TimestampedFloat",

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

package/dist/payloads/ScenarioEvent.d.ts

@@ -1,90 +0,0 @@
-import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
-/**
- * Something the exercise script did, at the moment it did it.
- *
- * A recording shows a vessel slowing down; it does not show whether that was
- * the autonomy under test deciding to slow down or the scenario commanding it.
- * Nothing else on the bus can settle that afterwards, which is why this is
- * evidence rather than convenience: without it, an evaluator reading a
- * recording cannot separate the system's behaviour from the exercise's
- * intervention.
- *
- * Distinct from the interfaces that *cause* these things. A simulator's RPC
- * surface (simulation_control/v1, scenario_control/v1) is how an operator acts
- * on a run; this subject is the record that an action occurred, published by
- * the authority that applied it, whether the cause was an operator, a scripted
- * event or a fault schedule.
- *
- * Relationship to ScenarioStatus: that answers "what is the world doing now?"
- * on a continuous cadence. This answers "what was done to it, and when?", once
- * per occurrence.
- */
-export interface ScenarioEvent {
-    $type: "keelson.ScenarioEvent";
-    /**
-     * Source timestamp: wall-clock time at which the event was applied.
-     * simulated time lives in tick below, and in a stepped or fast-time run the
-     * two diverge by design.
-     */
-    timestamp: Date | undefined;
-    /**
-     * Which run this happened in, and at which tick of it. A recording that
-     * spans a restore contains events from more than one run_id (see
-     * ScenarioStatus.parent_run_id), and an event attributed to the wrong run is
-     * worse than a missing one.
-     */
-    runId: string;
-    tick: number;
-    /**
-     * What was done. A free string rather than an enum, deliberately: the
-     * vocabulary belongs to the scenario format, not to keelson, and a fixed
-     * list here would decide what a simulator is allowed to script. Consumers
-     * that care match on values they know and record the rest verbatim.
-     */
-    action: string;
-    /**
-     * What it was done to, empty for a world-level event. Names an entity in the
-     * key space, so a consumer can join this against that entity's subjects.
-     */
-    entityId: string;
-    /**
-     * Arguments to the action — a new speed, a fault's target, a mark's label.
-     * Untyped because the actions are: constraining these would constrain the
-     * action vocabulary above by the back door.
-     */
-    parameters: {
-        [key: string]: string;
-    };
-    /**
-     * Human-readable note for a timeline. Never parsed: anything a consumer must
-     * act on belongs in action or parameters.
-     */
-    note: string;
-}
-export interface ScenarioEvent_ParametersEntry {
-    $type: "keelson.ScenarioEvent.ParametersEntry";
-    key: string;
-    value: string;
-}
-export declare const ScenarioEvent: MessageFns<ScenarioEvent, "keelson.ScenarioEvent">;
-export declare const ScenarioEvent_ParametersEntry: MessageFns<ScenarioEvent_ParametersEntry, "keelson.ScenarioEvent.ParametersEntry">;
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-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 Exclude<keyof T, "$type">]?: DeepPartial<T[K]>;
-} : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-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> | "$type">]: never;
-};
-interface MessageFns<T, V extends string> {
-    readonly $type: V;
-    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/payloads/ScenarioEvent.js

@@ -1,294 +0,0 @@
-"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: ScenarioEvent.proto
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScenarioEvent_ParametersEntry = exports.ScenarioEvent = void 0;
-/* eslint-disable */
-const wire_1 = require("@bufbuild/protobuf/wire");
-const timestamp_1 = require("./google/protobuf/timestamp");
-const typeRegistry_1 = require("./typeRegistry");
-function createBaseScenarioEvent() {
-    return {
-        $type: "keelson.ScenarioEvent",
-        timestamp: undefined,
-        runId: "",
-        tick: 0,
-        action: "",
-        entityId: "",
-        parameters: {},
-        note: "",
-    };
-}
-exports.ScenarioEvent = {
-    $type: "keelson.ScenarioEvent",
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.timestamp !== undefined) {
-            timestamp_1.Timestamp.encode(toTimestamp(message.timestamp), writer.uint32(10).fork()).join();
-        }
-        if (message.runId !== "") {
-            writer.uint32(18).string(message.runId);
-        }
-        if (message.tick !== 0) {
-            writer.uint32(24).uint64(message.tick);
-        }
-        if (message.action !== "") {
-            writer.uint32(34).string(message.action);
-        }
-        if (message.entityId !== "") {
-            writer.uint32(42).string(message.entityId);
-        }
-        Object.entries(message.parameters).forEach(([key, value]) => {
-            exports.ScenarioEvent_ParametersEntry.encode({ $type: "keelson.ScenarioEvent.ParametersEntry", key: key, value }, writer.uint32(50).fork()).join();
-        });
-        if (message.note !== "") {
-            writer.uint32(58).string(message.note);
-        }
-        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 = createBaseScenarioEvent();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.timestamp = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 18) {
-                        break;
-                    }
-                    message.runId = reader.string();
-                    continue;
-                }
-                case 3: {
-                    if (tag !== 24) {
-                        break;
-                    }
-                    message.tick = longToNumber(reader.uint64());
-                    continue;
-                }
-                case 4: {
-                    if (tag !== 34) {
-                        break;
-                    }
-                    message.action = reader.string();
-                    continue;
-                }
-                case 5: {
-                    if (tag !== 42) {
-                        break;
-                    }
-                    message.entityId = reader.string();
-                    continue;
-                }
-                case 6: {
-                    if (tag !== 50) {
-                        break;
-                    }
-                    const entry6 = exports.ScenarioEvent_ParametersEntry.decode(reader, reader.uint32());
-                    if (entry6.value !== undefined) {
-                        message.parameters[entry6.key] = entry6.value;
-                    }
-                    continue;
-                }
-                case 7: {
-                    if (tag !== 58) {
-                        break;
-                    }
-                    message.note = reader.string();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            $type: exports.ScenarioEvent.$type,
-            timestamp: isSet(object.timestamp) ? fromJsonTimestamp(object.timestamp) : undefined,
-            runId: isSet(object.runId) ? globalThis.String(object.runId) : "",
-            tick: isSet(object.tick) ? globalThis.Number(object.tick) : 0,
-            action: isSet(object.action) ? globalThis.String(object.action) : "",
-            entityId: isSet(object.entityId) ? globalThis.String(object.entityId) : "",
-            parameters: isObject(object.parameters)
-                ? Object.entries(object.parameters).reduce((acc, [key, value]) => {
-                    acc[key] = String(value);
-                    return acc;
-                }, {})
-                : {},
-            note: isSet(object.note) ? globalThis.String(object.note) : "",
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.timestamp !== undefined) {
-            obj.timestamp = message.timestamp.toISOString();
-        }
-        if (message.runId !== "") {
-            obj.runId = message.runId;
-        }
-        if (message.tick !== 0) {
-            obj.tick = Math.round(message.tick);
-        }
-        if (message.action !== "") {
-            obj.action = message.action;
-        }
-        if (message.entityId !== "") {
-            obj.entityId = message.entityId;
-        }
-        if (message.parameters) {
-            const entries = Object.entries(message.parameters);
-            if (entries.length > 0) {
-                obj.parameters = {};
-                entries.forEach(([k, v]) => {
-                    obj.parameters[k] = v;
-                });
-            }
-        }
-        if (message.note !== "") {
-            obj.note = message.note;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.ScenarioEvent.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseScenarioEvent();
-        message.timestamp = object.timestamp ?? undefined;
-        message.runId = object.runId ?? "";
-        message.tick = object.tick ?? 0;
-        message.action = object.action ?? "";
-        message.entityId = object.entityId ?? "";
-        message.parameters = Object.entries(object.parameters ?? {}).reduce((acc, [key, value]) => {
-            if (value !== undefined) {
-                acc[key] = globalThis.String(value);
-            }
-            return acc;
-        }, {});
-        message.note = object.note ?? "";
-        return message;
-    },
-};
-typeRegistry_1.messageTypeRegistry.set(exports.ScenarioEvent.$type, exports.ScenarioEvent);
-function createBaseScenarioEvent_ParametersEntry() {
-    return { $type: "keelson.ScenarioEvent.ParametersEntry", key: "", value: "" };
-}
-exports.ScenarioEvent_ParametersEntry = {
-    $type: "keelson.ScenarioEvent.ParametersEntry",
-    encode(message, writer = new wire_1.BinaryWriter()) {
-        if (message.key !== "") {
-            writer.uint32(10).string(message.key);
-        }
-        if (message.value !== "") {
-            writer.uint32(18).string(message.value);
-        }
-        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 = createBaseScenarioEvent_ParametersEntry();
-        while (reader.pos < end) {
-            const tag = reader.uint32();
-            switch (tag >>> 3) {
-                case 1: {
-                    if (tag !== 10) {
-                        break;
-                    }
-                    message.key = reader.string();
-                    continue;
-                }
-                case 2: {
-                    if (tag !== 18) {
-                        break;
-                    }
-                    message.value = reader.string();
-                    continue;
-                }
-            }
-            if ((tag & 7) === 4 || tag === 0) {
-                break;
-            }
-            reader.skip(tag & 7);
-        }
-        return message;
-    },
-    fromJSON(object) {
-        return {
-            $type: exports.ScenarioEvent_ParametersEntry.$type,
-            key: isSet(object.key) ? globalThis.String(object.key) : "",
-            value: isSet(object.value) ? globalThis.String(object.value) : "",
-        };
-    },
-    toJSON(message) {
-        const obj = {};
-        if (message.key !== "") {
-            obj.key = message.key;
-        }
-        if (message.value !== "") {
-            obj.value = message.value;
-        }
-        return obj;
-    },
-    create(base) {
-        return exports.ScenarioEvent_ParametersEntry.fromPartial(base ?? {});
-    },
-    fromPartial(object) {
-        const message = createBaseScenarioEvent_ParametersEntry();
-        message.key = object.key ?? "";
-        message.value = object.value ?? "";
-        return message;
-    },
-};
-typeRegistry_1.messageTypeRegistry.set(exports.ScenarioEvent_ParametersEntry.$type, exports.ScenarioEvent_ParametersEntry);
-function toTimestamp(date) {
-    const seconds = Math.trunc(date.getTime() / 1000);
-    const nanos = (date.getTime() % 1000) * 1000000;
-    return { $type: "google.protobuf.Timestamp", 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 isObject(value) {
-    return typeof value === "object" && value !== null;
-}
-function isSet(value) {
-    return value !== null && value !== undefined;
-}

package/dist/payloads/ScenarioTickAck.d.ts

@@ -1,81 +0,0 @@
-import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
-/**
- * A participant telling the clock authority it has finished a tick.
- *
- * The other half of the barrier ScenarioStatus already describes. A
- * ScenarioParticipant declares a Role and reports an acknowledged_tick, but
- * that message is published *by the authority*, about the participant — there
- * has been no way for the participant itself to say the thing the authority is
- * reporting. Implementations have used a raw JSON subject for it.
- *
- * Publish one per tick, on the participant's own key. The entity and source
- * are already in the key expression, so they are not repeated here: two places
- * to say who acknowledged is two places for them to disagree.
- */
-export interface ScenarioTickAck {
-    $type: "keelson.ScenarioTickAck";
-    /** Source timestamp: when the acknowledgement was produced. */
-    timestamp: Date | undefined;
-    /**
-     * The run and tick being acknowledged. run_id is not redundant: after a
-     * restore, a participant that is still running carries the old run's ticks
-     * in flight, and an ack matched on tick alone would satisfy the new run's
-     * barrier with the previous run's work.
-     */
-    runId: string;
-    tick: number;
-    disposition: ScenarioTickAck_Disposition;
-    /**
-     * Why, when disposition is SKIPPED or FAILED. Free text for an operator or
-     * a post-run report; empty otherwise.
-     */
-    detail: string;
-}
-/**
- * What the participant did with this tick. A BLOCKING participant is
- * expected to COMPLETE every one; a DECIMATING participant is explicitly
- * permitted to skip work to keep up, and this is where it says so — a skip
- * that looks identical to a completion on the wire makes the distinction
- * ScenarioParticipant.Role draws unobservable.
- */
-export declare enum ScenarioTickAck_Disposition {
-    DISPOSITION_UNKNOWN = 0,
-    /** COMPLETED - The work for this tick is done. */
-    COMPLETED = 1,
-    /**
-     * SKIPPED - Deliberately did less than a full tick's work, and stayed causal.
-     * Not an error: the participant is keeping up as designed.
-     */
-    SKIPPED = 2,
-    /**
-     * FAILED - Could not do the work. The authority decides what that means for the
-     * run — a failed tick from a BLOCKING participant is a failed run, from a
-     * DECIMATING one it is a degraded one — but it must be able to tell this
-     * apart from silence, which is indistinguishable from a dead process.
-     */
-    FAILED = 3,
-    UNRECOGNIZED = -1
-}
-export declare function scenarioTickAck_DispositionFromJSON(object: any): ScenarioTickAck_Disposition;
-export declare function scenarioTickAck_DispositionToJSON(object: ScenarioTickAck_Disposition): string;
-export declare const ScenarioTickAck: MessageFns<ScenarioTickAck, "keelson.ScenarioTickAck">;
-type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-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 Exclude<keyof T, "$type">]?: DeepPartial<T[K]>;
-} : Partial<T>;
-type KeysOfUnion<T> = T extends T ? keyof T : never;
-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> | "$type">]: never;
-};
-interface MessageFns<T, V extends string> {
-    readonly $type: V;
-    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 {};