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

package/dist/payloads/Alarm.js

@@ -5,10 +5,11 @@
 //   protoc               v6.30.2
 // source: Alarm.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Visual = exports.AlarmAcknowledgment = exports.Alarm = exports.alarm_SeverityToJSON = exports.alarm_SeverityFromJSON = exports.Alarm_Severity = exports.alarm_AckSchemeToJSON = exports.alarm_AckSchemeFromJSON = exports.Alarm_AckScheme = exports.alarm_PriorityToJSON = exports.alarm_PriorityFromJSON = exports.Alarm_Priority = exports.alarm_CategoryToJSON = exports.alarm_CategoryFromJSON = exports.Alarm_Category = void 0;
+exports.Visual = exports.AlarmAcknowledgment = exports.Alarm = exports.alarm_AckSchemeToJSON = exports.alarm_AckSchemeFromJSON = exports.Alarm_AckScheme = exports.alarm_PriorityToJSON = exports.alarm_PriorityFromJSON = exports.Alarm_Priority = exports.alarm_CategoryToJSON = exports.alarm_CategoryFromJSON = exports.Alarm_Category = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const Audio_1 = require("./Audio");
+const Severity_1 = require("./Severity");
 const CompressedImage_1 = require("./foxglove/CompressedImage");
 const CompressedVideo_1 = require("./foxglove/CompressedVideo");
 const RawImage_1 = require("./foxglove/RawImage");
@@ -161,57 +162,6 @@ function alarm_AckSchemeToJSON(object) {
     }
 }
 exports.alarm_AckSchemeToJSON = alarm_AckSchemeToJSON;
-var Alarm_Severity;
-(function (Alarm_Severity) {
-    Alarm_Severity[Alarm_Severity["SEVERITY_UNSPECIFIED"] = 0] = "SEVERITY_UNSPECIFIED";
-    Alarm_Severity[Alarm_Severity["SEVERITY_LOW"] = 1] = "SEVERITY_LOW";
-    Alarm_Severity[Alarm_Severity["SEVERITY_MEDIUM"] = 2] = "SEVERITY_MEDIUM";
-    Alarm_Severity[Alarm_Severity["SEVERITY_HIGH"] = 3] = "SEVERITY_HIGH";
-    Alarm_Severity[Alarm_Severity["SEVERITY_CRITICAL"] = 4] = "SEVERITY_CRITICAL";
-    Alarm_Severity[Alarm_Severity["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-})(Alarm_Severity || (exports.Alarm_Severity = Alarm_Severity = {}));
-function alarm_SeverityFromJSON(object) {
-    switch (object) {
-        case 0:
-        case "SEVERITY_UNSPECIFIED":
-            return Alarm_Severity.SEVERITY_UNSPECIFIED;
-        case 1:
-        case "SEVERITY_LOW":
-            return Alarm_Severity.SEVERITY_LOW;
-        case 2:
-        case "SEVERITY_MEDIUM":
-            return Alarm_Severity.SEVERITY_MEDIUM;
-        case 3:
-        case "SEVERITY_HIGH":
-            return Alarm_Severity.SEVERITY_HIGH;
-        case 4:
-        case "SEVERITY_CRITICAL":
-            return Alarm_Severity.SEVERITY_CRITICAL;
-        case -1:
-        case "UNRECOGNIZED":
-        default:
-            return Alarm_Severity.UNRECOGNIZED;
-    }
-}
-exports.alarm_SeverityFromJSON = alarm_SeverityFromJSON;
-function alarm_SeverityToJSON(object) {
-    switch (object) {
-        case Alarm_Severity.SEVERITY_UNSPECIFIED:
-            return "SEVERITY_UNSPECIFIED";
-        case Alarm_Severity.SEVERITY_LOW:
-            return "SEVERITY_LOW";
-        case Alarm_Severity.SEVERITY_MEDIUM:
-            return "SEVERITY_MEDIUM";
-        case Alarm_Severity.SEVERITY_HIGH:
-            return "SEVERITY_HIGH";
-        case Alarm_Severity.SEVERITY_CRITICAL:
-            return "SEVERITY_CRITICAL";
-        case Alarm_Severity.UNRECOGNIZED:
-        default:
-            return "UNRECOGNIZED";
-    }
-}
-exports.alarm_SeverityToJSON = alarm_SeverityToJSON;
 function createBaseAlarm() {
     return {
         $type: "keelson.Alarm",
@@ -408,7 +358,7 @@ exports.Alarm = {
             expirationTimeUtc: isSet(object.expirationTimeUtc) ? fromJsonTimestamp(object.expirationTimeUtc) : undefined,
             durationSeconds: isSet(object.durationSeconds) ? globalThis.Number(object.durationSeconds) : 0,
             ackScheme: isSet(object.ackScheme) ? alarm_AckSchemeFromJSON(object.ackScheme) : 0,
-            severity: isSet(object.severity) ? alarm_SeverityFromJSON(object.severity) : 0,
+            severity: isSet(object.severity) ? (0, Severity_1.severityLevelFromJSON)(object.severity) : 0,
             acknowledged: isSet(object.acknowledged) ? globalThis.Boolean(object.acknowledged) : false,
         };
     },
@@ -451,7 +401,7 @@ exports.Alarm = {
             obj.ackScheme = alarm_AckSchemeToJSON(message.ackScheme);
         }
         if (message.severity !== 0) {
-            obj.severity = alarm_SeverityToJSON(message.severity);
+            obj.severity = (0, Severity_1.severityLevelToJSON)(message.severity);
         }
         if (message.acknowledged !== false) {
             obj.acknowledged = message.acknowledged;

package/dist/payloads/ChecklistEvent.d.ts

@@ -0,0 +1,152 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { ChecklistItemEvidence } from "./ChecklistEvidence";
+/**
+ * Represents a single auditable action performed on a checklist by an operator.
+ * Used for real-time synchronization of checklist activity between Remote Operations Centres.
+ */
+export interface ChecklistEvent {
+    $type: "keelson.ChecklistEvent";
+    timestamp: Date | undefined;
+    eventId: string;
+    eventType: ChecklistEvent_EventType;
+    /** Operator identity */
+    operatorId: string;
+    username: string;
+    role: string;
+    rocSite: string;
+    /** Checklist context */
+    procedureId: string;
+    itemId: string;
+    /** Event-specific text payload (note text, flag reason, resolution text) */
+    detail: string;
+    /** Reference ID for additive entries (note_id, evidence_id) */
+    referenceId: string;
+    /**
+     * Which RUN of `procedure_id` this event belongs to.
+     *
+     * Empty means a publisher that predates the run model; a receiver adopts such an event under a
+     * legacy run keyed by the procedure id rather than dropping it.
+     */
+    runId: string;
+    /** Set on EVENT_TYPE_EVIDENCE_ATTACHED. Metadata only — see ChecklistEvidence.proto. */
+    evidence: ChecklistItemEvidence | undefined;
+    /**
+     * The corrected instant, on EVENT_TYPE_TIME_SET.
+     *
+     * This used to travel as a UTC ISO-8601 string in `detail`, in a message that already imports
+     * google.protobuf.Timestamp — so every consumer wrote its own parser, and every parser was a
+     * chance to disagree about an instant in a safety record.
+     *
+     * LEGACY FALLBACK: a publisher predating this field leaves it unset and writes the string. A
+     * receiver reads this field when `corrected_field` is set, and falls back to parsing `detail`
+     * only when `corrected_field == TIME_FIELD_UNKNOWN` — never the other way round, so a
+     * publisher writing both cannot be misread. Publishers SHOULD write both until every consumer
+     * is known to read the typed pair; recordings full of the string form must keep replaying.
+     */
+    correctedTime: Date | undefined;
+    /**
+     * Which timestamp `corrected_time` replaces. Set together with it, or neither.
+     *
+     * TIME_FIELD_UNKNOWN on an EVENT_TYPE_TIME_SET means a legacy publisher: fall back to the
+     * `reference_id` string ("started_at", "completed_at", "run_started_at"). An unrecognised
+     * value here is dropped, not guessed — a correction applied to the wrong field is worse than
+     * one not applied at all.
+     */
+    correctedField: ChecklistEvent_TimeField;
+}
+export declare enum ChecklistEvent_EventType {
+    EVENT_TYPE_UNKNOWN = 0,
+    EVENT_TYPE_CHECKLIST_OPENED = 1,
+    EVENT_TYPE_ITEM_STARTED = 2,
+    EVENT_TYPE_ITEM_COMPLETED = 3,
+    EVENT_TYPE_ITEM_REVERTED = 4,
+    EVENT_TYPE_NOTE_ADDED = 5,
+    EVENT_TYPE_ITEM_FLAGGED = 6,
+    EVENT_TYPE_FLAG_RESOLVED = 7,
+    /**
+     * EVENT_TYPE_PROCEDURE_STARTED - The run boundary markers. STARTED moves a run to ACTIVE (from PLANNED, or straight from
+     * creation); COMPLETED is the sign-off once every required item is done.
+     */
+    EVENT_TYPE_PROCEDURE_STARTED = 8,
+    EVENT_TYPE_PROCEDURE_COMPLETED = 9,
+    /** EVENT_TYPE_RUN_PLANNED - A run queued for later, with or without a due time. */
+    EVENT_TYPE_RUN_PLANNED = 10,
+    /** EVENT_TYPE_RUN_ABANDONED - A run stopped without completing. The reason is required and travels in `detail`. */
+    EVENT_TYPE_RUN_ABANDONED = 11,
+    /**
+     * EVENT_TYPE_EVIDENCE_ATTACHED - A photo attached to an item. The metadata rides in `evidence`; the bytes are published
+     * separately to `checklist_evidence/{evidence_id}`.
+     */
+    EVENT_TYPE_EVIDENCE_ATTACHED = 12,
+    /**
+     * EVENT_TYPE_TIME_SET - A timestamp corrected after the fact — "I finished at 14:45, I am only ticking it now".
+     *
+     * A dedicated type rather than a backdated ITEM_COMPLETED, because ITEM_COMPLETED resolves
+     * conflicts earliest-wins: a completion moved LATER hits that guard on every station, logs a
+     * "confirmed" row, and changes nothing. The guard is right for genuine concurrent completion
+     * and must not be relaxed for this.
+     *
+     * The corrected instant travels in `corrected_time` and the field it corrects in
+     * `corrected_field`. See those fields for what a receiver does with a publisher that
+     * predates them.
+     *
+     * Applying it patches ONLY that timestamp — status and author are untouched — and it is
+     * recorded as its own kind of entry. In a safety record a corrected time that renders
+     * identically to an original one is a claim nobody can audit.
+     */
+    EVENT_TYPE_TIME_SET = 13,
+    /**
+     * EVENT_TYPE_ITEM_REOPENED - An item taken back out of "done", with the reason in `detail`.
+     *
+     * Publishers have been spelling this EVENT_TYPE_ITEM_REVERTED = 4 with the reason in `detail`,
+     * because adding an enum value costs a release cycle. The behaviour and the audit trail were
+     * right; only the name misled — "reverted" reads as undoing a mistake, while reopening is a
+     * deliberate, reasoned act that a supervisor performs on a record that already stands.
+     *
+     * EVENT_TYPE_ITEM_REVERTED stays valid and is deliberately NOT reserved: recordings and
+     * durable snapshots already contain 4, and they must keep decoding. Treat the two as the same
+     * act; prefer this one for anything published from now on.
+     */
+    EVENT_TYPE_ITEM_REOPENED = 15,
+    UNRECOGNIZED = -1
+}
+export declare function checklistEvent_EventTypeFromJSON(object: any): ChecklistEvent_EventType;
+export declare function checklistEvent_EventTypeToJSON(object: ChecklistEvent_EventType): string;
+/**
+ * Which timestamp an EVENT_TYPE_TIME_SET corrects.
+ *
+ * An enum rather than the field's name as a string, because a string target is matched by
+ * every consumer against its own spelling: a typo is not an error, it is a silent no-op that
+ * logs an audited correction and patches nothing.
+ */
+export declare enum ChecklistEvent_TimeField {
+    TIME_FIELD_UNKNOWN = 0,
+    TIME_FIELD_ITEM_STARTED_AT = 1,
+    TIME_FIELD_ITEM_COMPLETED_AT = 2,
+    /** TIME_FIELD_RUN_STARTED_AT - The run's own start. Ignores `item_id`. */
+    TIME_FIELD_RUN_STARTED_AT = 3,
+    UNRECOGNIZED = -1
+}
+export declare function checklistEvent_TimeFieldFromJSON(object: any): ChecklistEvent_TimeField;
+export declare function checklistEvent_TimeFieldToJSON(object: ChecklistEvent_TimeField): string;
+export declare const ChecklistEvent: MessageFns<ChecklistEvent, "keelson.ChecklistEvent">;
+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 {};