@rise-maritime/keelson-js 0.6.0-alpha.282.dev.2 → 0.6.0-alpha.307.dev.2

package/dist/interfaces/NavigationRiskControl.d.ts

@@ -0,0 +1,161 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { CommandResult } from "./VehicleCommon";
+export declare const protobufPackage = "keelson.interfaces.navigation_risk_control";
+/** Why the producer is assessing a vessel. */
+export declare enum Origin {
+    ORIGIN_UNSPECIFIED = 0,
+    /** ORIGIN_DEPLOYMENT - from the producer's own configuration; cannot be stopped remotely */
+    ORIGIN_DEPLOYMENT = 1,
+    /** ORIGIN_ENROLLED - started through start_assessment */
+    ORIGIN_ENROLLED = 2,
+    UNRECOGNIZED = -1
+}
+export declare function originFromJSON(object: any): Origin;
+export declare function originToJSON(object: Origin): string;
+/** One own-ship input: which source on the assessed vessel to read `subject` from. */
+export interface InputSource {
+    /** e.g. location_fix, heading_true_north_deg, course_over_ground_deg */
+    subject: string;
+    /** exactly one source on the vessel's entity; never a wildcard */
+    sourceId: string;
+}
+/** One traffic feed: targets published under `{entity_id}/pubsub/{subject}/{source_id}/@target/*`. */
+export interface TrafficFeed {
+    entityId: string;
+    sourceId: string;
+}
+/**
+ * The own ship's particulars the model needs. Absent means not known, never zero: a missing
+ * draught makes grounding not measurable, it does not make it safe.
+ */
+export interface OwnShipParticulars {
+    lengthOverAllM?: number | undefined;
+    breadthOverAllM?: number | undefined;
+    draughtMaxM?: number | undefined;
+    /**
+     * Where the figures came from, in words, for the record: e.g. "registry sf18; draught from pilot
+     * card pc_… signed 2026-09-20".
+     */
+    basis: string;
+}
+/** What to assess and from which data. */
+export interface AssessmentSpec {
+    /** the vessel assessed */
+    entityId: string;
+    /** location_fix is required */
+    ownShipInputs: InputSource[];
+    trafficFeeds: TrafficFeed[];
+    ownShip: OwnShipParticulars | undefined;
+    /**
+     * Target ids never assessed as traffic — typically the vessel's own MMSI, so it is not its own
+     * target.
+     */
+    excludeTargetIds: string[];
+}
+export interface Assessment {
+    spec: AssessmentSpec | undefined;
+    origin: Origin;
+    /** Bumped each time the spec is replaced. The value if_revision must match. */
+    revision: number;
+    startedAt: Date | undefined;
+    /** requested_by of the start that created or last replaced it */
+    enrolledBy: string;
+}
+export interface ListAssessmentsRequest {
+}
+export interface ListAssessmentsResponse {
+    assessments: Assessment[];
+    /** How many vessels this producer will assess at once; 0 = not declared. */
+    capacity: number;
+}
+export interface StartAssessmentRequest {
+    spec: AssessmentSpec | undefined;
+    /** Who asked, for the record (e.g. a station or operator id). Not an authorisation. */
+    requestedBy: string;
+    /** Replace an existing assessment of spec.entity_id. Only honoured with a matching if_revision. */
+    replace: boolean;
+    ifRevision?: number | undefined;
+}
+export interface StartAssessmentResponse {
+    /**
+     * ACCEPTED: assessing (now, or already with this spec). DENIED: already assessed with a
+     * different spec, or a revision mismatch — see `assessment`. TEMPORARILY_REJECTED: at capacity.
+     */
+    result: CommandResult;
+    detail: string;
+    /** The assessment as it now stands: the new one on ACCEPTED, the existing one on DENIED. */
+    assessment?: Assessment | undefined;
+}
+export interface StopAssessmentRequest {
+    entityId: string;
+    requestedBy: string;
+}
+export interface StopAssessmentResponse {
+    /**
+     * ACCEPTED: no longer assessed (including when it was not assessed). DENIED: the vessel is
+     * ORIGIN_DEPLOYMENT and is stopped only by reconfiguring the producer.
+     */
+    result: CommandResult;
+    detail: string;
+}
+export declare const InputSource: MessageFns<InputSource>;
+export declare const TrafficFeed: MessageFns<TrafficFeed>;
+export declare const OwnShipParticulars: MessageFns<OwnShipParticulars>;
+export declare const AssessmentSpec: MessageFns<AssessmentSpec>;
+export declare const Assessment: MessageFns<Assessment>;
+export declare const ListAssessmentsRequest: MessageFns<ListAssessmentsRequest>;
+export declare const ListAssessmentsResponse: MessageFns<ListAssessmentsResponse>;
+export declare const StartAssessmentRequest: MessageFns<StartAssessmentRequest>;
+export declare const StartAssessmentResponse: MessageFns<StartAssessmentResponse>;
+export declare const StopAssessmentRequest: MessageFns<StopAssessmentRequest>;
+export declare const StopAssessmentResponse: MessageFns<StopAssessmentResponse>;
+export type NavigationRiskControlDefinition = typeof NavigationRiskControlDefinition;
+export declare const NavigationRiskControlDefinition: {
+    readonly name: "NavigationRiskControl";
+    readonly fullName: "keelson.interfaces.navigation_risk_control.NavigationRiskControl";
+    readonly methods: {
+        readonly list_assessments: {
+            readonly name: "list_assessments";
+            readonly requestType: MessageFns<ListAssessmentsRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<ListAssessmentsResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly start_assessment: {
+            readonly name: "start_assessment";
+            readonly requestType: MessageFns<StartAssessmentRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StartAssessmentResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly stop_assessment: {
+            readonly name: "stop_assessment";
+            readonly requestType: MessageFns<StopAssessmentRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StopAssessmentResponse>;
+            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 {};