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

package/dist/interfaces/Route.js

@@ -5,8 +5,8 @@
 //   protoc               v6.30.2
 // source: Route.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Schedule = exports.Schedules = exports.Leg = exports.Waypoint = exports.DefaultWaypoint = exports.Waypoints = exports.RouteInfo = exports.Route = exports.Extensions_Entry_AttributesEntry = exports.Extensions_Entry = exports.Extensions = exports.CircleGeometry = exports.RouteRef = exports.schedule_OriginToJSON = exports.schedule_OriginFromJSON = exports.Schedule_Origin = exports.actionPointRequiredActionToJSON = exports.actionPointRequiredActionFromJSON = exports.ActionPointRequiredAction = exports.envelopeBoundToJSON = exports.envelopeBoundFromJSON = exports.EnvelopeBound = exports.routeStatusToJSON = exports.routeStatusFromJSON = exports.RouteStatus = exports.routeTopologyToJSON = exports.routeTopologyFromJSON = exports.RouteTopology = exports.geometryTypeToJSON = exports.geometryTypeFromJSON = exports.GeometryType = exports.colregTrafficIntensityToJSON = exports.colregTrafficIntensityFromJSON = exports.ColregTrafficIntensity = exports.colregSituationToJSON = exports.colregSituationFromJSON = exports.ColregSituation = exports.hazardZoneTypeToJSON = exports.hazardZoneTypeFromJSON = exports.HazardZoneType = exports.routeChallengeTypeToJSON = exports.routeChallengeTypeFromJSON = exports.RouteChallengeType = exports.operationalContextToJSON = exports.operationalContextFromJSON = exports.OperationalContext = exports.autonomyLevelToJSON = exports.autonomyLevelFromJSON = exports.AutonomyLevel = exports.protobufPackage = void 0;
-exports.RouteStatusUpdate = exports.RouteSignature = exports.RouteSignatures = exports.RouteIssue = exports.RouteChallenge = exports.HazardZone = exports.ActionPoint = exports.ActionPoints = exports.ScheduleElement = void 0;
+exports.Waypoint = exports.DefaultWaypoint = exports.Waypoints = exports.RouteInfo = exports.Route = exports.Extensions_Entry_AttributesEntry = exports.Extensions_Entry = exports.Extensions = exports.CircleGeometry = exports.RouteRef = exports.schedule_OriginToJSON = exports.schedule_OriginFromJSON = exports.Schedule_Origin = exports.actionPointRequiredActionToJSON = exports.actionPointRequiredActionFromJSON = exports.ActionPointRequiredAction = exports.envelopeBoundToJSON = exports.envelopeBoundFromJSON = exports.EnvelopeBound = exports.routeStatusToJSON = exports.routeStatusFromJSON = exports.RouteStatus = exports.routeTopologyToJSON = exports.routeTopologyFromJSON = exports.RouteTopology = exports.xtdCorridorModeToJSON = exports.xtdCorridorModeFromJSON = exports.XtdCorridorMode = exports.geometryTypeToJSON = exports.geometryTypeFromJSON = exports.GeometryType = exports.colregTrafficIntensityToJSON = exports.colregTrafficIntensityFromJSON = exports.ColregTrafficIntensity = exports.colregSituationToJSON = exports.colregSituationFromJSON = exports.ColregSituation = exports.hazardZoneTypeToJSON = exports.hazardZoneTypeFromJSON = exports.HazardZoneType = exports.routeChallengeTypeToJSON = exports.routeChallengeTypeFromJSON = exports.RouteChallengeType = exports.operationalContextToJSON = exports.operationalContextFromJSON = exports.OperationalContext = exports.autonomyLevelToJSON = exports.autonomyLevelFromJSON = exports.AutonomyLevel = exports.protobufPackage = void 0;
+exports.RouteStatusUpdate = exports.RouteSignature = exports.RouteSignatures = exports.RouteIssue = exports.RouteChallenge = exports.HazardZone = exports.ActionPoint = exports.ActionPoints = exports.ScheduleElement = exports.Schedule = exports.Schedules = exports.XtdBoundaryPoint = exports.Leg = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const Coordinate_1 = require("./Coordinate");
@@ -432,6 +432,65 @@ function geometryTypeToJSON(object) {
     }
 }
 exports.geometryTypeToJSON = geometryTypeToJSON;
+/**
+ * How a leg's XTD corridor is shaped. UNSPECIFIED MUST be read as FIXED:
+ * every leg published before this field existed is a fixed-width corridor, and
+ * reading it any other way would change routes nobody edited.
+ */
+var XtdCorridorMode;
+(function (XtdCorridorMode) {
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_UNSPECIFIED"] = 0] = "XTD_CORRIDOR_MODE_UNSPECIFIED";
+    /**
+     * XTD_CORRIDOR_MODE_FIXED - Fixed width: parallel lines at xtd_port_m / xtd_starboard_m either side of
+     * track.
+     */
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_FIXED"] = 1] = "XTD_CORRIDOR_MODE_FIXED";
+    /**
+     * XTD_CORRIDOR_MODE_VARIABLE - Variable width: a boundary drawn by the planner (Leg.xtd_port_boundary /
+     * xtd_starboard_boundary), e.g. a corridor that narrows past a shoal.
+     * The metre fields (xtd_port_m / xtd_starboard_m and the monitoring pair)
+     * MUST NOT exceed the closest approach to track of that side's drawn
+     * boundary: they are the INSCRIBED fixed corridor. A monitor that does not
+     * evaluate the boundary then alarms early on a wide stretch and never late at
+     * the narrow one, which is the direction an XTD limit has to fail. Such a
+     * monitor SHOULD report the leg as monitored at reduced fidelity, which is
+     * why its alarm may come early.
+     */
+    XtdCorridorMode[XtdCorridorMode["XTD_CORRIDOR_MODE_VARIABLE"] = 2] = "XTD_CORRIDOR_MODE_VARIABLE";
+    XtdCorridorMode[XtdCorridorMode["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(XtdCorridorMode || (exports.XtdCorridorMode = XtdCorridorMode = {}));
+function xtdCorridorModeFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "XTD_CORRIDOR_MODE_UNSPECIFIED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED;
+        case 1:
+        case "XTD_CORRIDOR_MODE_FIXED":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED;
+        case 2:
+        case "XTD_CORRIDOR_MODE_VARIABLE":
+            return XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return XtdCorridorMode.UNRECOGNIZED;
+    }
+}
+exports.xtdCorridorModeFromJSON = xtdCorridorModeFromJSON;
+function xtdCorridorModeToJSON(object) {
+    switch (object) {
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_UNSPECIFIED:
+            return "XTD_CORRIDOR_MODE_UNSPECIFIED";
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_FIXED:
+            return "XTD_CORRIDOR_MODE_FIXED";
+        case XtdCorridorMode.XTD_CORRIDOR_MODE_VARIABLE:
+            return "XTD_CORRIDOR_MODE_VARIABLE";
+        case XtdCorridorMode.UNRECOGNIZED:
+        default:
+            return "UNRECOGNIZED";
+    }
+}
+exports.xtdCorridorModeToJSON = xtdCorridorModeToJSON;
 /**
  * Whether a route's waypoint list closes back on itself. RTZ 1.2 has no such
  * concept, so producers either repeated the first waypoint (breaking id
@@ -2219,6 +2278,9 @@ function createBaseLeg() {
         xtdStarboardM: undefined,
         xtdMonitoringPortM: undefined,
         xtdMonitoringStarboardM: undefined,
+        xtdCorridorMode: 0,
+        xtdPortBoundary: [],
+        xtdStarboardBoundary: [],
         safetyContourM: undefined,
         safetyDepthM: undefined,
         ukcStaticM: undefined,
@@ -2256,6 +2318,15 @@ exports.Leg = {
         if (message.xtdMonitoringStarboardM !== undefined) {
             writer.uint32(37).float(message.xtdMonitoringStarboardM);
         }
+        if (message.xtdCorridorMode !== 0) {
+            writer.uint32(40).int32(message.xtdCorridorMode);
+        }
+        for (const v of message.xtdPortBoundary) {
+            exports.XtdBoundaryPoint.encode(v, writer.uint32(50).fork()).join();
+        }
+        for (const v of message.xtdStarboardBoundary) {
+            exports.XtdBoundaryPoint.encode(v, writer.uint32(58).fork()).join();
+        }
         if (message.safetyContourM !== undefined) {
             writer.uint32(85).float(message.safetyContourM);
         }
@@ -2356,6 +2427,27 @@ exports.Leg = {
                     message.xtdMonitoringStarboardM = reader.float();
                     continue;
                 }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.xtdCorridorMode = reader.int32();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.xtdPortBoundary.push(exports.XtdBoundaryPoint.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.xtdStarboardBoundary.push(exports.XtdBoundaryPoint.decode(reader, reader.uint32()));
+                    continue;
+                }
                 case 10: {
                     if (tag !== 85) {
                         break;
@@ -2519,6 +2611,13 @@ exports.Leg = {
             xtdMonitoringStarboardM: isSet(object.xtdMonitoringStarboardM)
                 ? globalThis.Number(object.xtdMonitoringStarboardM)
                 : undefined,
+            xtdCorridorMode: isSet(object.xtdCorridorMode) ? xtdCorridorModeFromJSON(object.xtdCorridorMode) : 0,
+            xtdPortBoundary: globalThis.Array.isArray(object?.xtdPortBoundary)
+                ? object.xtdPortBoundary.map((e) => exports.XtdBoundaryPoint.fromJSON(e))
+                : [],
+            xtdStarboardBoundary: globalThis.Array.isArray(object?.xtdStarboardBoundary)
+                ? object.xtdStarboardBoundary.map((e) => exports.XtdBoundaryPoint.fromJSON(e))
+                : [],
             safetyContourM: isSet(object.safetyContourM) ? globalThis.Number(object.safetyContourM) : undefined,
             safetyDepthM: isSet(object.safetyDepthM) ? globalThis.Number(object.safetyDepthM) : undefined,
             ukcStaticM: isSet(object.ukcStaticM) ? globalThis.Number(object.ukcStaticM) : undefined,
@@ -2558,6 +2657,15 @@ exports.Leg = {
         if (message.xtdMonitoringStarboardM !== undefined) {
             obj.xtdMonitoringStarboardM = message.xtdMonitoringStarboardM;
         }
+        if (message.xtdCorridorMode !== 0) {
+            obj.xtdCorridorMode = xtdCorridorModeToJSON(message.xtdCorridorMode);
+        }
+        if (message.xtdPortBoundary?.length) {
+            obj.xtdPortBoundary = message.xtdPortBoundary.map((e) => exports.XtdBoundaryPoint.toJSON(e));
+        }
+        if (message.xtdStarboardBoundary?.length) {
+            obj.xtdStarboardBoundary = message.xtdStarboardBoundary.map((e) => exports.XtdBoundaryPoint.toJSON(e));
+        }
         if (message.safetyContourM !== undefined) {
             obj.safetyContourM = message.safetyContourM;
         }
@@ -2632,6 +2740,9 @@ exports.Leg = {
         message.xtdStarboardM = object.xtdStarboardM ?? undefined;
         message.xtdMonitoringPortM = object.xtdMonitoringPortM ?? undefined;
         message.xtdMonitoringStarboardM = object.xtdMonitoringStarboardM ?? undefined;
+        message.xtdCorridorMode = object.xtdCorridorMode ?? 0;
+        message.xtdPortBoundary = object.xtdPortBoundary?.map((e) => exports.XtdBoundaryPoint.fromPartial(e)) || [];
+        message.xtdStarboardBoundary = object.xtdStarboardBoundary?.map((e) => exports.XtdBoundaryPoint.fromPartial(e)) || [];
         message.safetyContourM = object.safetyContourM ?? undefined;
         message.safetyDepthM = object.safetyDepthM ?? undefined;
         message.ukcStaticM = object.ukcStaticM ?? undefined;
@@ -2658,6 +2769,106 @@ exports.Leg = {
         return message;
     },
 };
+function createBaseXtdBoundaryPoint() {
+    return { position: undefined, alongTrackFraction: undefined, offsetM: undefined, inTurn: false };
+}
+exports.XtdBoundaryPoint = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.position !== undefined) {
+            Coordinate_1.Coordinate.encode(message.position, writer.uint32(10).fork()).join();
+        }
+        if (message.alongTrackFraction !== undefined) {
+            writer.uint32(17).double(message.alongTrackFraction);
+        }
+        if (message.offsetM !== undefined) {
+            writer.uint32(29).float(message.offsetM);
+        }
+        if (message.inTurn !== false) {
+            writer.uint32(32).bool(message.inTurn);
+        }
+        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 = createBaseXtdBoundaryPoint();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.position = Coordinate_1.Coordinate.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 17) {
+                        break;
+                    }
+                    message.alongTrackFraction = reader.double();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 29) {
+                        break;
+                    }
+                    message.offsetM = reader.float();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.inTurn = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            position: isSet(object.position) ? Coordinate_1.Coordinate.fromJSON(object.position) : undefined,
+            alongTrackFraction: isSet(object.alongTrackFraction) ? globalThis.Number(object.alongTrackFraction) : undefined,
+            offsetM: isSet(object.offsetM) ? globalThis.Number(object.offsetM) : undefined,
+            inTurn: isSet(object.inTurn) ? globalThis.Boolean(object.inTurn) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.position !== undefined) {
+            obj.position = Coordinate_1.Coordinate.toJSON(message.position);
+        }
+        if (message.alongTrackFraction !== undefined) {
+            obj.alongTrackFraction = message.alongTrackFraction;
+        }
+        if (message.offsetM !== undefined) {
+            obj.offsetM = message.offsetM;
+        }
+        if (message.inTurn !== false) {
+            obj.inTurn = message.inTurn;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.XtdBoundaryPoint.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseXtdBoundaryPoint();
+        message.position = (object.position !== undefined && object.position !== null)
+            ? Coordinate_1.Coordinate.fromPartial(object.position)
+            : undefined;
+        message.alongTrackFraction = object.alongTrackFraction ?? undefined;
+        message.offsetM = object.offsetM ?? undefined;
+        message.inTurn = object.inTurn ?? false;
+        return message;
+    },
+};
 function createBaseSchedules() {
     return { schedule: [], extensions: undefined };
 }

package/dist/interfaces/VesselType.d.ts

@@ -0,0 +1,133 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "keelson";
+export interface VesselType {
+    /** Timestamp at which the vessel type was last asserted or observed. */
+    timestamp: Date | undefined;
+    vesselType: VesselType_VesselType;
+}
+/** Vessel type based on the AIS standard (ITU-R M.1371-5 Table 53). */
+export declare enum VesselType_VesselType {
+    NOT_AVAILABLE = 0,
+    RESERVED_1 = 1,
+    RESERVED_2 = 2,
+    RESERVED_3 = 3,
+    RESERVED_4 = 4,
+    RESERVED_5 = 5,
+    RESERVED_6 = 6,
+    RESERVED_7 = 7,
+    RESERVED_8 = 8,
+    RESERVED_9 = 9,
+    RESERVED_10 = 10,
+    RESERVED_11 = 11,
+    RESERVED_12 = 12,
+    RESERVED_13 = 13,
+    RESERVED_14 = 14,
+    RESERVED_15 = 15,
+    RESERVED_16 = 16,
+    RESERVED_17 = 17,
+    RESERVED_18 = 18,
+    RESERVED_19 = 19,
+    WIG_ALL = 20,
+    WIG_HAZARDOUS_A = 21,
+    WIG_HAZARDOUS_B = 22,
+    WIG_HAZARDOUS_C = 23,
+    WIG_HAZARDOUS_D = 24,
+    WIG_RESERVED_25 = 25,
+    WIG_RESERVED_26 = 26,
+    WIG_RESERVED_27 = 27,
+    WIG_RESERVED_28 = 28,
+    WIG_RESERVED_29 = 29,
+    FISHING = 30,
+    TOWING = 31,
+    TOWING_LARGE = 32,
+    DREDGING_UNDERWATER_OPS = 33,
+    DIVING_OPS = 34,
+    MILITARY_OPS = 35,
+    SAILING = 36,
+    PLEASURE_CRAFT = 37,
+    RESERVED_38 = 38,
+    RESERVED_39 = 39,
+    HSC_ALL = 40,
+    HSC_HAZARDOUS_A = 41,
+    HSC_HAZARDOUS_B = 42,
+    HSC_HAZARDOUS_C = 43,
+    HSC_HAZARDOUS_D = 44,
+    HSC_RESERVED_45 = 45,
+    HSC_RESERVED_46 = 46,
+    HSC_RESERVED_47 = 47,
+    HSC_RESERVED_48 = 48,
+    HSC_NO_INFO = 49,
+    PILOT = 50,
+    SEARCH_RESCUE = 51,
+    TUG = 52,
+    PORT_TENDER = 53,
+    ANTI_POLLUTION = 54,
+    LAW_ENFORCEMENT = 55,
+    SPARE_LOCAL_56 = 56,
+    SPARE_LOCAL_57 = 57,
+    MEDICAL_TRANSPORT = 58,
+    NONCOMBATANT = 59,
+    PASSENGER_ALL = 60,
+    PASSENGER_HAZARDOUS_A = 61,
+    PASSENGER_HAZARDOUS_B = 62,
+    PASSENGER_HAZARDOUS_C = 63,
+    PASSENGER_HAZARDOUS_D = 64,
+    PASSENGER_RESERVED_65 = 65,
+    PASSENGER_RESERVED_66 = 66,
+    PASSENGER_RESERVED_67 = 67,
+    PASSENGER_RESERVED_68 = 68,
+    PASSENGER_NO_INFO = 69,
+    CARGO_ALL = 70,
+    CARGO_HAZARDOUS_A = 71,
+    CARGO_HAZARDOUS_B = 72,
+    CARGO_HAZARDOUS_C = 73,
+    CARGO_HAZARDOUS_D = 74,
+    CARGO_RESERVED_75 = 75,
+    CARGO_RESERVED_76 = 76,
+    CARGO_RESERVED_77 = 77,
+    CARGO_RESERVED_78 = 78,
+    CARGO_NO_INFO = 79,
+    TANKER_ALL = 80,
+    TANKER_HAZARDOUS_A = 81,
+    TANKER_HAZARDOUS_B = 82,
+    TANKER_HAZARDOUS_C = 83,
+    TANKER_HAZARDOUS_D = 84,
+    TANKER_RESERVED_85 = 85,
+    TANKER_RESERVED_86 = 86,
+    TANKER_RESERVED_87 = 87,
+    TANKER_RESERVED_88 = 88,
+    TANKER_NO_INFO = 89,
+    OTHER_ALL = 90,
+    OTHER_HAZARDOUS_A = 91,
+    OTHER_HAZARDOUS_B = 92,
+    OTHER_HAZARDOUS_C = 93,
+    OTHER_HAZARDOUS_D = 94,
+    OTHER_RESERVED_95 = 95,
+    OTHER_RESERVED_96 = 96,
+    OTHER_RESERVED_97 = 97,
+    OTHER_RESERVED_98 = 98,
+    OTHER_NO_INFO = 99,
+    UNRECOGNIZED = -1
+}
+export declare function vesselType_VesselTypeFromJSON(object: any): VesselType_VesselType;
+export declare function vesselType_VesselTypeToJSON(object: VesselType_VesselType): string;
+export declare const VesselType: MessageFns<VesselType>;
+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 {};