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

package/dist/payloads/RouteChangeEvent.d.ts

@@ -0,0 +1,42 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export interface RouteChangeEvent {
+    $type: "keelson.RouteChangeEvent";
+    /** Unique change identifier (UUID). Also used as the trailing key segment. */
+    changeId: string;
+    routeId: string;
+    /** Edition transition described by this event. */
+    oldEdition: number;
+    newEdition: number;
+    at: Date | undefined;
+    /** Identity that authored the change. */
+    authorId: string;
+    authorSite: string;
+    /**
+     * Free-form reason ("initial plan", "bridge review", "weather reroute",
+     * "force_override", "migrated_from_localstorage", ...).
+     */
+    reason: string;
+    /** Short human-readable summary ("added 3 waypoints", "shifted WP-5 80m N"). */
+    changeSummary: string;
+}
+export declare const RouteChangeEvent: MessageFns<RouteChangeEvent, "keelson.RouteChangeEvent">;
+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/RouteChangeEvent.js

@@ -0,0 +1,223 @@
+"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: RouteChangeEvent.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteChangeEvent = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+const timestamp_1 = require("./google/protobuf/timestamp");
+const typeRegistry_1 = require("./typeRegistry");
+function createBaseRouteChangeEvent() {
+    return {
+        $type: "keelson.RouteChangeEvent",
+        changeId: "",
+        routeId: "",
+        oldEdition: 0,
+        newEdition: 0,
+        at: undefined,
+        authorId: "",
+        authorSite: "",
+        reason: "",
+        changeSummary: "",
+    };
+}
+exports.RouteChangeEvent = {
+    $type: "keelson.RouteChangeEvent",
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.changeId !== "") {
+            writer.uint32(10).string(message.changeId);
+        }
+        if (message.routeId !== "") {
+            writer.uint32(18).string(message.routeId);
+        }
+        if (message.oldEdition !== 0) {
+            writer.uint32(24).uint32(message.oldEdition);
+        }
+        if (message.newEdition !== 0) {
+            writer.uint32(32).uint32(message.newEdition);
+        }
+        if (message.at !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.at), writer.uint32(42).fork()).join();
+        }
+        if (message.authorId !== "") {
+            writer.uint32(50).string(message.authorId);
+        }
+        if (message.authorSite !== "") {
+            writer.uint32(58).string(message.authorSite);
+        }
+        if (message.reason !== "") {
+            writer.uint32(66).string(message.reason);
+        }
+        if (message.changeSummary !== "") {
+            writer.uint32(74).string(message.changeSummary);
+        }
+        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 = createBaseRouteChangeEvent();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.changeId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.routeId = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.oldEdition = reader.uint32();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.newEdition = reader.uint32();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.at = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.authorId = reader.string();
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.authorSite = reader.string();
+                    continue;
+                }
+                case 8: {
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.reason = reader.string();
+                    continue;
+                }
+                case 9: {
+                    if (tag !== 74) {
+                        break;
+                    }
+                    message.changeSummary = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            $type: exports.RouteChangeEvent.$type,
+            changeId: isSet(object.changeId) ? globalThis.String(object.changeId) : "",
+            routeId: isSet(object.routeId) ? globalThis.String(object.routeId) : "",
+            oldEdition: isSet(object.oldEdition) ? globalThis.Number(object.oldEdition) : 0,
+            newEdition: isSet(object.newEdition) ? globalThis.Number(object.newEdition) : 0,
+            at: isSet(object.at) ? fromJsonTimestamp(object.at) : undefined,
+            authorId: isSet(object.authorId) ? globalThis.String(object.authorId) : "",
+            authorSite: isSet(object.authorSite) ? globalThis.String(object.authorSite) : "",
+            reason: isSet(object.reason) ? globalThis.String(object.reason) : "",
+            changeSummary: isSet(object.changeSummary) ? globalThis.String(object.changeSummary) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.changeId !== "") {
+            obj.changeId = message.changeId;
+        }
+        if (message.routeId !== "") {
+            obj.routeId = message.routeId;
+        }
+        if (message.oldEdition !== 0) {
+            obj.oldEdition = Math.round(message.oldEdition);
+        }
+        if (message.newEdition !== 0) {
+            obj.newEdition = Math.round(message.newEdition);
+        }
+        if (message.at !== undefined) {
+            obj.at = message.at.toISOString();
+        }
+        if (message.authorId !== "") {
+            obj.authorId = message.authorId;
+        }
+        if (message.authorSite !== "") {
+            obj.authorSite = message.authorSite;
+        }
+        if (message.reason !== "") {
+            obj.reason = message.reason;
+        }
+        if (message.changeSummary !== "") {
+            obj.changeSummary = message.changeSummary;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RouteChangeEvent.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseRouteChangeEvent();
+        message.changeId = object.changeId ?? "";
+        message.routeId = object.routeId ?? "";
+        message.oldEdition = object.oldEdition ?? 0;
+        message.newEdition = object.newEdition ?? 0;
+        message.at = object.at ?? undefined;
+        message.authorId = object.authorId ?? "";
+        message.authorSite = object.authorSite ?? "";
+        message.reason = object.reason ?? "";
+        message.changeSummary = object.changeSummary ?? "";
+        return message;
+    },
+};
+typeRegistry_1.messageTypeRegistry.set(exports.RouteChangeEvent.$type, exports.RouteChangeEvent);
+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 isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/payloads/RouteEditAuthority.d.ts

@@ -0,0 +1,87 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export interface RouteEditAuthority {
+    $type: "keelson.RouteEditAuthority";
+    /** The route whose edit lock this message refers to. */
+    routeId: string;
+    /** Identity of the controlling operator+site, e.g. "ted@vessel-bridge". */
+    controllerId: string;
+    /** Free-form site label ("ROC-1", "vessel-bridge"). */
+    controllerSite: string;
+    /**
+     * Random token (16 random bytes, hex-encoded). Subscribers use the token
+     * to filter out their own publications and to validate that a release
+     * message originates from the current holder.
+     */
+    token: string;
+    /**
+     * Lease window, IN THE HOLDER'S CLOCK.
+     *
+     * These are the holder's own view of its lease and are for display, logging
+     * and diagnostics. A receiver MUST NOT decide expiry by comparing expires_at
+     * against its own clock — see lease_ttl_seconds below and protocol
+     * specification §6.5.1.
+     */
+    grantedAt: Date | undefined;
+    expiresAt: Date | undefined;
+    lastHeartbeat: Date | undefined;
+    /**
+     * THE LEASE CONTRACT. This is what receivers arm on.
+     *
+     * On every accepted message a receiver sets its own deadline at
+     * (local time of receipt + lease_ttl_seconds) and expires the lease when its
+     * own clock passes it. A duration is the only lease quantity that survives
+     * the two sites disagreeing about what time it is: a receiver running five
+     * seconds fast would, comparing expires_at, expire a live lease early and
+     * hand it to a second editor while the first still believes it holds it —
+     * with both sites behaving correctly by their own reading.
+     *
+     * Network delay pushes the receiver's deadline later, never earlier, so the
+     * rule fails in the safe direction: late to release rather than early to
+     * steal.
+     */
+    leaseTtlSeconds: number;
+    /** The holder's refresh cadence. Informational. */
+    heartbeatIntervalSeconds: number;
+    /**
+     * Set true on graceful release. A released=true message MUST carry the
+     * same token as the most recent grant for the receiver to accept it.
+     */
+    released: boolean;
+}
+export interface RouteEditRequest {
+    $type: "keelson.RouteEditRequest";
+    routeId: string;
+    /** Identity of the would-be editor. */
+    requesterId: string;
+    requesterSite: string;
+    requestedAt: Date | undefined;
+    /** Human-readable reason ("planning update", "weather reroute", ...). */
+    reason: string;
+    /**
+     * If true and accepted, an override is recorded in the route change log
+     * regardless of whether an edit follows.
+     */
+    force: boolean;
+}
+export declare const RouteEditAuthority: MessageFns<RouteEditAuthority, "keelson.RouteEditAuthority">;
+export declare const RouteEditRequest: MessageFns<RouteEditRequest, "keelson.RouteEditRequest">;
+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 {};