@ksp-gonogo/kerbcast 1.9.1 → 1.10.0

package/dist/__generated__/types.d.ts

@@ -249,9 +249,32 @@ export declare enum ErrorSource {
     Sidecar = "sidecar",
     Client = "client"
 }
+/**
+ * Machine-readable reason for an `ErrorPayload`, so a client can react to a
+ * refusal without matching on the wording of `message`.
+ */
+export declare enum ErrorCode {
+    /** Every video slot is bound; the client negotiated too few transceivers. */
+    NoFreeSlot = "no-free-slot",
+    /**
+     * No camera with the requested flight id is registered. For cameras
+     * requested at connect time this is true as of the offer; the camera may
+     * appear later, so a client can retry with `Subscribe`.
+     */
+    CameraNotFound = "camera-not-found",
+    /** The named camera exists but its part is gone. */
+    CameraDestroyed = "camera-destroyed"
+}
 export interface ErrorPayload {
     message: string;
     source?: ErrorSource;
+    /** Camera the error is about, when it concerns one. */
+    flightId?: number;
+    /**
+     * Reason code for refusals a client may want to act on. Absent for
+     * errors that only carry a human-readable `message`.
+     */
+    code?: ErrorCode;
 }
 export interface FlightIdPayload {
     flightId: number;

package/dist/__generated__/types.js

@@ -109,3 +109,20 @@ export var ErrorSource;
     ErrorSource["Sidecar"] = "sidecar";
     ErrorSource["Client"] = "client";
 })(ErrorSource || (ErrorSource = {}));
+/**
+ * Machine-readable reason for an `ErrorPayload`, so a client can react to a
+ * refusal without matching on the wording of `message`.
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /** Every video slot is bound; the client negotiated too few transceivers. */
+    ErrorCode["NoFreeSlot"] = "no-free-slot";
+    /**
+     * No camera with the requested flight id is registered. For cameras
+     * requested at connect time this is true as of the offer; the camera may
+     * appear later, so a client can retry with `Subscribe`.
+     */
+    ErrorCode["CameraNotFound"] = "camera-not-found";
+    /** The named camera exists but its part is gone. */
+    ErrorCode["CameraDestroyed"] = "camera-destroyed";
+})(ErrorCode || (ErrorCode = {}));

package/dist/testing/index.js

@@ -1,4 +1,4 @@
-import { CameraKind, CameraLifecycle, ErrorSource, Layer, QualityPreset, TrackMode } from "../__generated__/types";
+import { CameraKind, CameraLifecycle, ErrorCode, ErrorSource, Layer, QualityPreset, TrackMode } from "../__generated__/types";
 function buildCamera(init) {
     return {
         flightId: init.flightId,
@@ -525,7 +525,12 @@ export class MockSidecar {
                 if (freeMid === undefined) {
                     this._sendToClient({
                         type: "error",
-                        content: { message: "no free slot", source: ErrorSource.Sidecar },
+                        content: {
+                            message: "no free slot",
+                            source: ErrorSource.Sidecar,
+                            flightId,
+                            code: ErrorCode.NoFreeSlot,
+                        },
                     });
                 }
                 else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ksp-gonogo/kerbcast",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "TypeScript client for the kerbcast KSP camera-streaming sidecar. KerbcastClient wraps the WebRTC peer + control channel; wire-format types are typeshare-generated from the sidecar's Rust protocol module.",
   "license": "MIT",
   "author": "Jon Pepler",

package/src/__generated__/types.ts

@@ -265,9 +265,33 @@ export enum ErrorSource {
 	Client = "client",
 }
 
+/**
+ * Machine-readable reason for an `ErrorPayload`, so a client can react to a
+ * refusal without matching on the wording of `message`.
+ */
+export enum ErrorCode {
+	/** Every video slot is bound; the client negotiated too few transceivers. */
+	NoFreeSlot = "no-free-slot",
+	/**
+	 * No camera with the requested flight id is registered. For cameras
+	 * requested at connect time this is true as of the offer; the camera may
+	 * appear later, so a client can retry with `Subscribe`.
+	 */
+	CameraNotFound = "camera-not-found",
+	/** The named camera exists but its part is gone. */
+	CameraDestroyed = "camera-destroyed",
+}
+
 export interface ErrorPayload {
 	message: string;
 	source?: ErrorSource;
+	/** Camera the error is about, when it concerns one. */
+	flightId?: number;
+	/**
+	 * Reason code for refusals a client may want to act on. Absent for
+	 * errors that only carry a human-readable `message`.
+	 */
+	code?: ErrorCode;
 }
 
 export interface FlightIdPayload {

package/src/testing/index.ts

@@ -1,5 +1,5 @@
 import type { AdaptiveShedPayload, CameraState, ClientMessage, ErrorPayload, ServerMessage, SettingsStatePayload } from "../__generated__/types";
-import { CameraKind, CameraLifecycle, CrewLocation, ErrorSource, Layer, QualityPreset, TrackMode } from "../__generated__/types";
+import { CameraKind, CameraLifecycle, CrewLocation, ErrorCode, ErrorSource, Layer, QualityPreset, TrackMode } from "../__generated__/types";
 import type {
   DiscoveredCamera,
   InboundVideoStats,
@@ -646,7 +646,12 @@ export class MockSidecar {
         if (freeMid === undefined) {
           this._sendToClient({
             type: "error",
-            content: { message: "no free slot", source: ErrorSource.Sidecar },
+            content: {
+              message: "no free slot",
+              source: ErrorSource.Sidecar,
+              flightId,
+              code: ErrorCode.NoFreeSlot,
+            },
           });
         } else {
           this._slotBindings.set(freeMid, flightId);