@rise-maritime/keelson-js 0.6.0-experimental.6 → 0.6.0-experimental.7

package/dist/index.d.ts

@@ -257,6 +257,14 @@ export declare function getInterfaceDefinition(interfaceAndVersion: string): {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly set_range: {
+            readonly name: "set_range";
+            readonly requestType: import("./interfaces/ReplayControl").MessageFns<import("./interfaces/ReplayControl").SetRangeRequest>;
+            readonly requestStream: false;
+            readonly responseType: import("./interfaces/ReplayControl").MessageFns<import("./interfaces/ReplayControl").ReplaySuccessResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 } | {
     readonly name: "RoutePlanner";

package/dist/interfaces/ReplayControl.d.ts

@@ -72,6 +72,26 @@ export interface SetSpeedRequest {
 export interface SetLoopRequest {
     loop: boolean;
 }
+/**
+ * Bound playback to a span of the loaded file.
+ *
+ * The operation a reviewer wants constantly: an incident occupies twenty seconds of a two-hour
+ * recording, and you want those twenty seconds -- repeatedly, if `set_loop` is on. Composing it from
+ * `seek` does not work well, because a client can only notice the end has passed AFTER it has
+ * published past it; see RISE-Maritime/keelson#198.
+ *
+ * BOTH FIELDS UNSET CLEARS THE RANGE and returns playback to the whole file. Clearing has to be
+ * expressible, and it is: these are MESSAGE fields, so proto3 gives them explicit presence and a
+ * server distinguishes unset from a zero Timestamp with `HasField`. That distinction is load-bearing
+ * rather than pedantic -- epoch 0 is a legitimate log time, and a recording from a device with no
+ * clock really does start there, so a zero value could not have doubled as "none".
+ */
+export interface SetRangeRequest {
+    /** First message replayed. Unset means the file's start. */
+    start: Date | undefined;
+    /** Playback stops or loops on reaching this. Unset means the file's end. */
+    end: Date | undefined;
+}
 /** Generic acknowledgement for control commands. */
 export interface ReplaySuccessResponse {
 }
@@ -85,6 +105,7 @@ export declare const LoadFileRequest: MessageFns<LoadFileRequest>;
 export declare const SeekRequest: MessageFns<SeekRequest>;
 export declare const SetSpeedRequest: MessageFns<SetSpeedRequest>;
 export declare const SetLoopRequest: MessageFns<SetLoopRequest>;
+export declare const SetRangeRequest: MessageFns<SetRangeRequest>;
 export declare const ReplaySuccessResponse: MessageFns<ReplaySuccessResponse>;
 export type ReplayControlDefinition = typeof ReplayControlDefinition;
 export declare const ReplayControlDefinition: {
@@ -164,6 +185,14 @@ export declare const ReplayControlDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly set_range: {
+            readonly name: "set_range";
+            readonly requestType: MessageFns<SetRangeRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<ReplaySuccessResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;

package/dist/interfaces/ReplayControl.js

@@ -5,7 +5,7 @@
 //   protoc               v6.30.2
 // source: ReplayControl.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReplayControlDefinition = exports.ReplaySuccessResponse = exports.SetLoopRequest = exports.SetSpeedRequest = exports.SeekRequest = exports.LoadFileRequest = exports.DescribeFileResponse = exports.ChannelInfo = exports.DescribeFileRequest = exports.ListFilesResponse = exports.ListFilesRequest = exports.FileInfo = exports.protobufPackage = void 0;
+exports.ReplayControlDefinition = exports.ReplaySuccessResponse = exports.SetRangeRequest = exports.SetLoopRequest = exports.SetSpeedRequest = exports.SeekRequest = exports.LoadFileRequest = exports.DescribeFileResponse = exports.ChannelInfo = exports.DescribeFileRequest = exports.ListFilesResponse = exports.ListFilesRequest = exports.FileInfo = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const empty_1 = require("./google/protobuf/empty");
@@ -751,6 +751,74 @@ exports.SetLoopRequest = {
         return message;
     },
 };
+function createBaseSetRangeRequest() {
+    return { start: undefined, end: undefined };
+}
+exports.SetRangeRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.start !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.start), writer.uint32(10).fork()).join();
+        }
+        if (message.end !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.end), writer.uint32(18).fork()).join();
+        }
+        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 = createBaseSetRangeRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.start = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.end = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            start: isSet(object.start) ? fromJsonTimestamp(object.start) : undefined,
+            end: isSet(object.end) ? fromJsonTimestamp(object.end) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.start !== undefined) {
+            obj.start = message.start.toISOString();
+        }
+        if (message.end !== undefined) {
+            obj.end = message.end.toISOString();
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.SetRangeRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetRangeRequest();
+        message.start = object.start ?? undefined;
+        message.end = object.end ?? undefined;
+        return message;
+    },
+};
 function createBaseReplaySuccessResponse() {
     return {};
 }
@@ -865,6 +933,14 @@ exports.ReplayControlDefinition = {
             responseStream: false,
             options: {},
         },
+        set_range: {
+            name: "set_range",
+            requestType: exports.SetRangeRequest,
+            requestStream: false,
+            responseType: exports.ReplaySuccessResponse,
+            responseStream: false,
+            options: {},
+        },
     },
 };
 function toTimestamp(date) {

package/dist/interfaces/serviceRegistry.d.ts

@@ -239,6 +239,14 @@ export declare const serviceDefinitions: {
                 readonly responseStream: false;
                 readonly options: {};
             };
+            readonly set_range: {
+                readonly name: "set_range";
+                readonly requestType: import("./ReplayControl").MessageFns<import("./ReplayControl").SetRangeRequest>;
+                readonly requestStream: false;
+                readonly responseType: import("./ReplayControl").MessageFns<import("./ReplayControl").ReplaySuccessResponse>;
+                readonly responseStream: false;
+                readonly options: {};
+            };
         };
     };
     readonly "route_planner/v1": {

package/dist/payloads/ReplayStatus.d.ts

@@ -32,6 +32,13 @@ export interface ReplayStatus {
     progressPct: number;
     /** Whether the replayer is configured to loop on end-of-file. */
     loop: boolean;
+    /**
+     * The active play range, when one is set. Reported so a client that did not set it -- a second
+     * station watching the same replay -- can still show what is being played, and so a client can
+     * tell "no range" from "a range it has forgotten". Unset when playback covers the whole file.
+     */
+    rangeStart: Date | undefined;
+    rangeEnd: Date | undefined;
     /** Identification of the daemon producing this sample. See DaemonInfo above. */
     daemon: DaemonInfo | undefined;
     /** Progress of an in-flight load_file, 0..100. Zero outside of LOADING. */

package/dist/payloads/ReplayStatus.js

@@ -169,6 +169,8 @@ function createBaseReplayStatus() {
         totalMessageCount: 0,
         progressPct: 0,
         loop: false,
+        rangeStart: undefined,
+        rangeEnd: undefined,
         daemon: undefined,
         loadProgressPct: 0,
         lastLoadError: "",
@@ -207,6 +209,12 @@ exports.ReplayStatus = {
         if (message.loop !== false) {
             writer.uint32(80).bool(message.loop);
         }
+        if (message.rangeStart !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.rangeStart), writer.uint32(90).fork()).join();
+        }
+        if (message.rangeEnd !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.rangeEnd), writer.uint32(98).fork()).join();
+        }
         if (message.daemon !== undefined) {
             exports.DaemonInfo.encode(message.daemon, writer.uint32(162).fork()).join();
         }
@@ -295,6 +303,20 @@ exports.ReplayStatus = {
                     message.loop = reader.bool();
                     continue;
                 }
+                case 11: {
+                    if (tag !== 90) {
+                        break;
+                    }
+                    message.rangeStart = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 12: {
+                    if (tag !== 98) {
+                        break;
+                    }
+                    message.rangeEnd = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
                 case 20: {
                     if (tag !== 162) {
                         break;
@@ -337,6 +359,8 @@ exports.ReplayStatus = {
             totalMessageCount: isSet(object.totalMessageCount) ? globalThis.Number(object.totalMessageCount) : 0,
             progressPct: isSet(object.progressPct) ? globalThis.Number(object.progressPct) : 0,
             loop: isSet(object.loop) ? globalThis.Boolean(object.loop) : false,
+            rangeStart: isSet(object.rangeStart) ? fromJsonTimestamp(object.rangeStart) : undefined,
+            rangeEnd: isSet(object.rangeEnd) ? fromJsonTimestamp(object.rangeEnd) : undefined,
             daemon: isSet(object.daemon) ? exports.DaemonInfo.fromJSON(object.daemon) : undefined,
             loadProgressPct: isSet(object.loadProgressPct) ? globalThis.Number(object.loadProgressPct) : 0,
             lastLoadError: isSet(object.lastLoadError) ? globalThis.String(object.lastLoadError) : "",
@@ -374,6 +398,12 @@ exports.ReplayStatus = {
         if (message.loop !== false) {
             obj.loop = message.loop;
         }
+        if (message.rangeStart !== undefined) {
+            obj.rangeStart = message.rangeStart.toISOString();
+        }
+        if (message.rangeEnd !== undefined) {
+            obj.rangeEnd = message.rangeEnd.toISOString();
+        }
         if (message.daemon !== undefined) {
             obj.daemon = exports.DaemonInfo.toJSON(message.daemon);
         }
@@ -400,6 +430,8 @@ exports.ReplayStatus = {
         message.totalMessageCount = object.totalMessageCount ?? 0;
         message.progressPct = object.progressPct ?? 0;
         message.loop = object.loop ?? false;
+        message.rangeStart = object.rangeStart ?? undefined;
+        message.rangeEnd = object.rangeEnd ?? undefined;
         message.daemon = (object.daemon !== undefined && object.daemon !== null)
             ? exports.DaemonInfo.fromPartial(object.daemon)
             : undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rise-maritime/keelson-js",
   "//version": "NOT the published version. The release workflow overwrites it from the release tag (npm version --no-git-tag-version), so tag and artifact cannot disagree. Only matters for local installs; do not hand-bump before tagging — that manual step is what broke release 0.5.4.",
-  "version": "0.6.0-experimental.6",
+  "version": "0.6.0-experimental.7",
   "description": "Keelson JavaScript SDK with Node-RED nodes",
   "main": "dist/index.js",
   "files": [