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

package/dist/payloads/Voyage.d.ts

@@ -0,0 +1,154 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { RouteRef } from "./Route";
+import { VesselType } from "./VesselType";
+import { Duration } from "./google/protobuf/duration";
+/**
+ * Voyage lifecycle status. Prefixed to avoid collision with RouteStatus
+ * values that share the keelson package.
+ */
+export declare enum VoyageStatus {
+    VOYAGE_STATUS_UNSPECIFIED = 0,
+    VOYAGE_STATUS_PLANNED = 1,
+    VOYAGE_STATUS_ACTIVE = 2,
+    VOYAGE_STATUS_PAUSED = 3,
+    VOYAGE_STATUS_COMPLETED = 4,
+    VOYAGE_STATUS_ABORTED = 5,
+    UNRECOGNIZED = -1
+}
+export declare function voyageStatusFromJSON(object: any): VoyageStatus;
+export declare function voyageStatusToJSON(object: VoyageStatus): string;
+/**
+ * Defined voyage audit actions. VOYAGE_AUDIT_ACTION_OTHER is the escape hatch
+ * when a publisher needs an action that isn't yet covered by this enum; the
+ * free-text `detail` field carries the specifics in that case.
+ */
+export declare enum VoyageAuditAction {
+    VOYAGE_AUDIT_ACTION_UNSPECIFIED = 0,
+    VOYAGE_AUDIT_ACTION_ACTIVATED = 1,
+    VOYAGE_AUDIT_ACTION_PAUSED = 2,
+    VOYAGE_AUDIT_ACTION_RESUMED = 3,
+    VOYAGE_AUDIT_ACTION_EDITION_BUMP = 4,
+    VOYAGE_AUDIT_ACTION_DEVIATION = 5,
+    VOYAGE_AUDIT_ACTION_REROUTE_ACCEPTED = 6,
+    VOYAGE_AUDIT_ACTION_COMPLETED = 7,
+    VOYAGE_AUDIT_ACTION_ABORTED = 8,
+    VOYAGE_AUDIT_ACTION_OTHER = 99,
+    UNRECOGNIZED = -1
+}
+export declare function voyageAuditActionFromJSON(object: any): VoyageAuditAction;
+export declare function voyageAuditActionToJSON(object: VoyageAuditAction): string;
+/** Single entry in the voyage audit trail. */
+export interface VoyageAuditEntry {
+    $type: "keelson.VoyageAuditEntry";
+    at: Date | undefined;
+    /** operatorId */
+    actorId: string;
+    /** ROC-1, vessel-bridge, ... */
+    actorSite: string;
+    action: VoyageAuditAction;
+    detail: string;
+}
+/**
+ * Auto-rerouting permissions and limits for autonomous execution of a voyage.
+ * Moved from keelson.Route — policy is per-execution, not per-plan, so the
+ * same Route may be sailed under different policies by different voyages.
+ */
+export interface DynamicReroutingPolicy {
+    $type: "keelson.DynamicReroutingPolicy";
+    /** Whether autonomous re-routing is allowed at all. */
+    autoRerouteAllowed: boolean;
+    /**
+     * Maximum cross-track deviation from the planned route an auto-reroute may
+     * introduce, in metres.
+     */
+    maxCrossTrackDeviationM?: number | undefined;
+    /** Maximum acceptable additional arrival delay introduced by a reroute. */
+    maxArrivalDelay: Duration | undefined;
+    /** Whether autonomous speed-profile changes are allowed. */
+    speedProfileChangeAllowed: boolean;
+    /**
+     * Maximum allowed deviation from planned SOG when speed-profile changes are
+     * allowed, in knots.
+     */
+    maxSogDeviationKnots?: number | undefined;
+}
+export interface Voyage {
+    $type: "keelson.Voyage";
+    /** Schema version this Voyage conforms to. */
+    version: string;
+    /** Globally unique voyage identifier (UUID recommended). */
+    voyageId: string;
+    routeRef: RouteRef | undefined;
+    /** -- Vessel identity -------------------------------------------------------- */
+    vesselMmsi: number;
+    vesselName: string;
+    vesselCallSign: string;
+    vesselImo: number;
+    /**
+     * Canonical AIS-aligned vessel type (ITU-R M.1371-5 Table 53). The
+     * timestamp inside the VesselType message records when this assignment was
+     * last asserted.
+     */
+    vesselType: VesselType | undefined;
+    /** -- Lifecycle -------------------------------------------------------------- */
+    status: VoyageStatus;
+    plannedDeparture: Date | undefined;
+    plannedArrival: Date | undefined;
+    startedAt: Date | undefined;
+    completedAt: Date | undefined;
+    /** -- Ports (UN/LOCODE + display name) --------------------------------------- */
+    departurePortLocode: string;
+    arrivalPortLocode: string;
+    departurePortName: string;
+    arrivalPortName: string;
+    /**
+     * -- Actual execution -------------------------------------------------------
+     * Pointer (Zenoh key expression) to a time-series of foxglove.LocationFix
+     * samples representing the actual track sailed.
+     */
+    actualTrackKeyExpr: string;
+    /** Summary metrics — full deviations live in the audit trail / change log. */
+    deviationCount: number;
+    maxXtdObservedM: number;
+    /**
+     * -- Linked artefacts -------------------------------------------------------
+     * Checklist procedure ids associated with this voyage (departure, transit,
+     * arrival, port-state, ...).
+     */
+    linkedProcedureIds: string[];
+    /**
+     * Append-only audit trail; bounded by the publisher (rolling window).
+     * Durable per-edition-bump events live separately under
+     * keelson.RouteChangeEvent on a storage-manager-backed key tree.
+     */
+    auditTrail: VoyageAuditEntry[];
+    /**
+     * Autonomous re-routing policy for this voyage. Moved from keelson.Route
+     * so the same Route can be sailed under different policies by different
+     * voyages (e.g. crewed vs unmanned).
+     */
+    reroutingPolicy: DynamicReroutingPolicy | undefined;
+}
+export declare const VoyageAuditEntry: MessageFns<VoyageAuditEntry, "keelson.VoyageAuditEntry">;
+export declare const DynamicReroutingPolicy: MessageFns<DynamicReroutingPolicy, "keelson.DynamicReroutingPolicy">;
+export declare const Voyage: MessageFns<Voyage, "keelson.Voyage">;
+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 {};