@ksp-gonogo/kerbcast-react 1.4.0

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.12.0 - 2026-06-07
+
+Initial release. Versioned in lockstep with `@jonpepler/kerbcast` and the
+sidecar binary.
+
+### Added
+
+- `CameraFeed`: the full-bleed camera feed component extracted from gonogo's
+  dashboard widget. Hover/tap-revealed chrome, camera picker menu, Next/Prev
+  step buttons, map-style zoom rod (hold-to-zoom buttons + debounced absolute
+  FoV slider), pan pad with discrete arrows and an analog drag ball, SIGNAL
+  LOST overlay, optional debug readout, automatic 16:9 render sizing via
+  ResizeObserver.
+- `CameraFeedHandle` imperative ref (`stepCamera`, `setZoomRate`,
+  `setPanAxis`, `nudgeZoom`, `nudgePan`) for host platforms that drive the
+  feed from their own input systems.
+- `KerbcastProvider` / `useKerbcastClient` context carrying the
+  `KerbcastClient`, plus a pluggable `KerbcastSubscriptions` seam with a
+  refcounting default (`createClientSubscriptions`).
+- `useKerbcastCameras` and `useKerbcastStream` hooks.
+- `buildCameraLabeler` and `isCameraDestroyed` utilities.
+- Theming hooks: accent colors read `--kerbcast-accent` /
+  `--kerbcast-accent-wash` CSS custom properties with the original values as
+  fallbacks.

package/LICENSE

@@ -0,0 +1,369 @@
+kerbcast
+Copyright (c) 2026 Jon Pepler
+
+This work is licensed under the Creative Commons
+Attribution-NonCommercial-ShareAlike 4.0 International License.
+Full legal text follows.
+
+
+Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
+Public License
+
+By exercising the Licensed Rights (defined below), You accept and agree
+to be bound by the terms and conditions of this Creative Commons
+Attribution-NonCommercial-ShareAlike 4.0 International Public License
+("Public License"). To the extent this Public License may be
+interpreted as a contract, You are granted the Licensed Rights in
+consideration of Your acceptance of these terms and conditions, and the
+Licensor grants You such rights in consideration of benefits the
+Licensor receives from making the Licensed Material available under
+these terms and conditions.
+
+
+Section 1 -- Definitions.
+
+  a. Adapted Material means material subject to Copyright and Similar
+     Rights that is derived from or based upon the Licensed Material
+     and in which the Licensed Material is translated, altered,
+     arranged, transformed, or otherwise modified in a manner requiring
+     permission under the Copyright and Similar Rights held by the
+     Licensor. For purposes of this Public License, where the Licensed
+     Material is a musical work, performance, or sound recording,
+     Adapted Material is always produced where the Licensed Material is
+     synched in timed relation with a moving image.
+
+  b. Adapter's License means the license You apply to Your Copyright
+     and Similar Rights in Your contributions to Adapted Material in
+     accordance with the terms and conditions of this Public License.
+
+  c. BY-NC-SA Compatible License means a license listed at
+     creativecommons.org/compatiblelicenses, approved by Creative
+     Commons as essentially the equivalent of this Public License.
+
+  d. Copyright and Similar Rights means copyright and/or similar rights
+     closely related to copyright including, without limitation,
+     performance, broadcast, sound recording, and Sui Generis Database
+     Rights, without regard to how the rights are labeled or
+     categorized. For purposes of this Public License, the rights
+     specified in Section 2(b)(1)-(2) are not Copyright and Similar
+     Rights.
+
+  e. Effective Technological Measures means those measures that, in the
+     absence of proper authority, may not be circumvented under laws
+     fulfilling obligations under Article 11 of the WIPO Copyright
+     Treaty adopted on December 20, 1996, and/or similar international
+     agreements.
+
+  f. Exceptions and Limitations means fair use, fair dealing, and/or
+     any other exception or limitation to Copyright and Similar Rights
+     that applies to Your use of the Licensed Material.
+
+  g. License Elements means the license attributes listed in the name
+     of a Creative Commons Public License. The License Elements of this
+     Public License are Attribution, NonCommercial, and ShareAlike.
+
+  h. Licensed Material means the artistic or literary work, database,
+     or other material to which the Licensor applied this Public
+     License.
+
+  i. Licensed Rights means the rights granted to You subject to the
+     terms and conditions of this Public License, which are limited to
+     all Copyright and Similar Rights that apply to Your use of the
+     Licensed Material and that the Licensor has authority to license.
+
+  j. Licensor means the individual(s) or entity(ies) granting rights
+     under this Public License.
+
+  k. NonCommercial means not primarily intended for or directed towards
+     commercial advantage or monetary compensation. For purposes of
+     this Public License, the exchange of the Licensed Material for
+     other material subject to Copyright and Similar Rights by digital
+     file-sharing or similar means is NonCommercial provided there is
+     no payment of monetary compensation in connection with the
+     exchange.
+
+  l. Share means to provide material to the public by any means or
+     process that requires permission under the Licensed Rights, such
+     as reproduction, public display, public performance, distribution,
+     dissemination, communication, or importation, and to make material
+     available to the public including in ways that members of the
+     public may access the material from a place and at a time
+     individually chosen by them.
+
+  m. Sui Generis Database Rights means rights other than copyright
+     resulting from Directive 96/9/EC of the European Parliament and of
+     the Council of 11 March 1996 on the legal protection of databases,
+     as amended and/or succeeded, as well as other essentially
+     equivalent rights anywhere in the world.
+
+  n. You means the individual or entity exercising the Licensed Rights
+     under this Public License. Your has a corresponding meaning.
+
+
+Section 2 -- Scope.
+
+  a. License grant.
+
+       1. Subject to the terms and conditions of this Public License,
+          the Licensor hereby grants You a worldwide, royalty-free,
+          non-sublicensable, non-exclusive, irrevocable license to
+          exercise the Licensed Rights in the Licensed Material to:
+
+            a. reproduce and Share the Licensed Material, in whole or
+               in part, for NonCommercial purposes only; and
+
+            b. produce, reproduce, and Share Adapted Material for
+               NonCommercial purposes only.
+
+       2. Exceptions and Limitations. For the avoidance of doubt, where
+          Exceptions and Limitations apply to Your use, this Public
+          License does not apply, and You do not need to comply with
+          its terms and conditions.
+
+       3. Term. The term of this Public License is specified in Section
+          6(a).
+
+       4. Media and formats; technical modifications allowed. The
+          Licensor authorizes You to exercise the Licensed Rights in
+          all media and formats whether now known or hereafter created,
+          and to make technical modifications necessary to do so. The
+          Licensor waives and/or agrees not to assert any right or
+          authority to forbid You from making technical modifications
+          necessary to exercise the Licensed Rights, including
+          technical modifications necessary to circumvent Effective
+          Technological Measures. For purposes of this Public License,
+          simply making modifications authorized by this Section 2(a)
+          (4) never produces Adapted Material.
+
+       5. Downstream recipients.
+
+            a. Offer from the Licensor -- Licensed Material. Every
+               recipient of the Licensed Material automatically
+               receives an offer from the Licensor to exercise the
+               Licensed Rights under the terms and conditions of this
+               Public License.
+
+            b. Additional offer from the Licensor -- Adapted Material.
+               Every recipient of Adapted Material from You
+               automatically receives an offer from the Licensor to
+               exercise the Licensed Rights in the Adapted Material
+               under the conditions of the Adapter's License You apply.
+
+            c. No downstream restrictions. You may not offer or impose
+               any additional or different terms or conditions on, or
+               apply any Effective Technological Measures to, the
+               Licensed Material if doing so restricts exercise of the
+               Licensed Rights by any recipient of the Licensed
+               Material.
+
+       6. No endorsement. Nothing in this Public License constitutes or
+          may be construed as permission to assert or imply that You
+          are, or that Your use of the Licensed Material is, connected
+          with, or sponsored, endorsed, or granted official status by,
+          the Licensor or others designated to receive attribution as
+          provided in Section 3(a)(1)(A)(i).
+
+  b. Other rights.
+
+       1. Moral rights, such as the right of integrity, are not
+          licensed under this Public License, nor are publicity,
+          privacy, and/or other similar personality rights; however, to
+          the extent possible, the Licensor waives and/or agrees not to
+          assert any such rights held by the Licensor to the limited
+          extent necessary to allow You to exercise the Licensed
+          Rights, but not otherwise.
+
+       2. Patent and trademark rights are not licensed under this
+          Public License.
+
+       3. To the extent possible, the Licensor waives any right to
+          collect royalties from You for the exercise of the Licensed
+          Rights, whether directly or through a collecting society
+          under any voluntary or waivable statutory or compulsory
+          licensing scheme. In all other cases the Licensor expressly
+          reserves any right to collect such royalties, including when
+          the Licensed Material is used other than for NonCommercial
+          purposes.
+
+
+Section 3 -- License Conditions.
+
+Your exercise of the Licensed Rights is expressly made subject to the
+following conditions.
+
+  a. Attribution.
+
+       1. If You Share the Licensed Material (including in modified
+          form), You must:
+
+            a. retain the following if it is supplied by the Licensor
+               with the Licensed Material:
+
+                 i. identification of the creator(s) of the Licensed
+                    Material and any others designated to receive
+                    attribution, in any reasonable manner requested by
+                    the Licensor (including by pseudonym if
+                    designated);
+
+                ii. a copyright notice;
+
+               iii. a notice that refers to this Public License;
+
+                iv. a notice that refers to the disclaimer of
+                    warranties;
+
+                 v. a URI or hyperlink to the Licensed Material to the
+                    extent reasonably practicable;
+
+            b. indicate if You modified the Licensed Material and
+               retain an indication of any previous modifications; and
+
+            c. indicate the Licensed Material is licensed under this
+               Public License, and include the text of, or the URI or
+               hyperlink to, this Public License.
+
+       2. You may satisfy the conditions in Section 3(a)(1) in any
+          reasonable manner based on the medium, means, and context in
+          which You Share the Licensed Material. For example, it may be
+          reasonable to satisfy the conditions by providing a URI or
+          hyperlink to a resource that includes the required
+          information.
+       3. If requested by the Licensor, You must remove any of the
+          information required by Section 3(a)(1)(A) to the extent
+          reasonably practicable.
+
+  b. ShareAlike.
+
+     In addition to the conditions in Section 3(a), if You Share
+     Adapted Material You produce, the following conditions also apply.
+
+       1. The Adapter's License You apply must be a Creative Commons
+          license with the same License Elements, this version or
+          later, or a BY-NC-SA Compatible License.
+
+       2. You must include the text of, or the URI or hyperlink to, the
+          Adapter's License You apply. You may satisfy this condition
+          in any reasonable manner based on the medium, means, and
+          context in which You Share Adapted Material.
+
+       3. You may not offer or impose any additional or different terms
+          or conditions on, or apply any Effective Technological
+          Measures to, Adapted Material that restrict exercise of the
+          rights granted under the Adapter's License You apply.
+
+
+Section 4 -- Sui Generis Database Rights.
+
+Where the Licensed Rights include Sui Generis Database Rights that
+apply to Your use of the Licensed Material:
+
+  a. for the avoidance of doubt, Section 2(a)(1) grants You the right
+     to extract, reuse, reproduce, and Share all or a substantial
+     portion of the contents of the database for NonCommercial purposes
+     only;
+
+  b. if You include all or a substantial portion of the database
+     contents in a database in which You have Sui Generis Database
+     Rights, then the database in which You have Sui Generis Database
+     Rights (but not its individual contents) is Adapted Material,
+     including for purposes of Section 3(b); and
+
+  c. You must comply with the conditions in Section 3(a) if You Share
+     all or a substantial portion of the contents of the database.
+
+For the avoidance of doubt, this Section 4 supplements and does not
+replace Your obligations under this Public License where the Licensed
+Rights include other Copyright and Similar Rights.
+
+
+Section 5 -- Disclaimer of Warranties and Limitation of Liability.
+
+  a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
+     EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
+     AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
+     ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
+     IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
+     WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
+     PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
+     ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
+     KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
+     ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
+
+  b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
+     TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
+     NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
+     INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
+     COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
+     USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
+     ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
+     DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
+     IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
+
+  c. The disclaimer of warranties and limitation of liability provided
+     above shall be interpreted in a manner that, to the extent
+     possible, most closely approximates an absolute disclaimer and
+     waiver of all liability.
+
+
+Section 6 -- Term and Termination.
+
+  a. This Public License applies for the term of the Copyright and
+     Similar Rights licensed here. However, if You fail to comply with
+     this Public License, then Your rights under this Public License
+     terminate automatically.
+
+  b. Where Your right to use the Licensed Material has terminated under
+     Section 6(a), it reinstates:
+
+       1. automatically as of the date the violation is cured, provided
+          it is cured within 30 days of Your discovery of the
+          violation; or
+
+       2. upon express reinstatement by the Licensor.
+
+     For the avoidance of doubt, this Section 6(b) does not affect any
+     right the Licensor may have to seek remedies for Your violations
+     of this Public License.
+
+  c. For the avoidance of doubt, the Licensor may also offer the
+     Licensed Material under separate terms or conditions or stop
+     distributing the Licensed Material at any time; however, doing so
+     will not terminate this Public License.
+
+  d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
+     License.
+
+
+Section 7 -- Other Terms and Conditions.
+
+  a. The Licensor shall not be bound by any additional or different
+     terms or conditions communicated by You unless expressly agreed.
+
+  b. Any arrangements, understandings, or agreements regarding the
+     Licensed Material not stated herein are separate from and
+     independent of the terms and conditions of this Public License.
+
+
+Section 8 -- Interpretation.
+
+  a. For the avoidance of doubt, this Public License does not, and
+     shall not be interpreted to, reduce, limit, restrict, or impose
+     conditions on any use of the Licensed Material that could lawfully
+     be made without permission under this Public License.
+
+  b. To the extent possible, if any provision of this Public License is
+     deemed unenforceable, it shall be automatically reformed to the
+     minimum extent necessary to make it enforceable. If the provision
+     cannot be reformed, it shall be severed from this Public License
+     without affecting the enforceability of the remaining terms and
+     conditions.
+
+  c. No term or condition of this Public License will be waived and no
+     failure to comply consented to unless expressly agreed to by the
+     Licensor.
+
+  d. Nothing in this Public License constitutes or may be interpreted
+     as a limitation upon, or waiver of, any privileges and immunities
+     that apply to the Licensor or You, including from the legal
+     processes of any jurisdiction or authority.
+

package/README.md

@@ -0,0 +1,26 @@
+# @ksp-gonogo/kerbcast-react
+
+React components and hooks for [kerbcast](https://github.com/ksp-gonogo/kerbcast) camera feeds.
+
+This package provides a shared `CameraFeed` component (and related hooks) consumed by
+both gonogo's mission-control dashboard and the kerbcast sidecar's embedded web page.
+
+## Install
+
+Published to public npm. No registry route or auth needed:
+
+```
+pnpm add @ksp-gonogo/kerbcast-react
+```
+
+Peer dependencies required: `react` (18 or 19), `react-dom`, `styled-components` (6).
+
+## Purpose
+
+Extracts camera-feed UI from gonogo into a reusable layer so both gonogo and the
+sidecar page consume the same component without duplicating protocol or rendering code.
+
+## Versioning
+
+This package tracks `@ksp-gonogo/kerbcast` version for version. Use matching versions of both.
+`./scripts/bump-version.sh` bumps them atomically.

package/dist/CameraFeed.d.ts

@@ -0,0 +1,126 @@
+import type { KerbcastClient } from "@ksp-gonogo/kerbcast";
+/**
+ * A consumer-supplied action rendered into the feed's top-right action bar.
+ * Lets a host page (e.g. the sidecar's spotlight toggle) inject controls
+ * without the library knowing what they do.
+ */
+export interface FeedAction {
+    /** Stable identity for the React key. */
+    id: string;
+    /** Accessible label; used for aria-label and the native tooltip. */
+    label: string;
+    /** Icon node, sized by the action bar (~14px). */
+    icon: React.ReactNode;
+    /** Toggle state: renders the button highlighted and sets aria-pressed. */
+    active?: boolean;
+    onClick: () => void;
+}
+/**
+ * A hook that yields the live `MediaStream` for a resolved flightId. Must be
+ * a stable reference (the same function identity every render) and called
+ * unconditionally, per the rules of hooks. Default: the built-in
+ * `useKerbcastStream`. Consumers wrap this to inject delayed playout,
+ * alternate transports, etc.; the feed stays unaware of what the wrapper
+ * does, and keeps binding whatever stream comes back to its `<video>`.
+ *
+ * A replacement takes over the camera subscription slot: the built-in
+ * `useKerbcastStream` (which acquires/releases the slot) does not run when
+ * this is supplied, so a replacement must either compose `useKerbcastStream`
+ * or acquire the slot itself, or the sidecar is never subscribed and the
+ * feed stays black.
+ */
+export type CameraStreamHook = (flightId: number | null) => MediaStream | null;
+export interface CameraFeedProps {
+    /** Override the context client for this feed only. */
+    client?: KerbcastClient;
+    /**
+     * KSP `Part.flightID` of the camera to display. `null` triggers
+     * auto-selection: the first live camera in the registry is latched.
+     */
+    flightId: number | null;
+    /**
+     * Called when the user explicitly picks a camera (picker, Next/Prev
+     * buttons). Never called on auto-latch.
+     */
+    onSelectCamera?: (flightId: number) => void;
+    /**
+     * Called whenever the camera this feed actually displays changes — including
+     * auto-latch and fallback picks, not just explicit selection. The argument
+     * is the resolved flightId (null when nothing is shown). Use it to label or
+     * annotate the feed by what it is really showing rather than what was
+     * requested; the two differ whenever auto-selection kicks in.
+     */
+    onDisplayedCameraChange?: (flightId: number | null) => void;
+    /** Show resolution + encoder readout. Default false. */
+    showDebugInfo?: boolean;
+    /**
+     * Whether to show animated static. `true`: stall ramps noise in over the
+     * held last frame; sourceless path shows live noise. `false`: stall freezes
+     * the last frame with a dim scrim and stale badge; sourceless path shows a
+     * plain black background. `undefined` (default): auto mode, reads
+     * `prefers-reduced-motion: reduce` at mount and follows changes at runtime
+     * (reduced motion defaults to off, normal motion defaults to on).
+     */
+    showStatic?: boolean;
+    /**
+     * "auto" (default): ResizeObserver drives `setRenderSize` at a 16:9 crop,
+     * debounced 500 ms. "none": no render-size feedback.
+     */
+    renderSize?: "auto" | "none";
+    /** Message shown when no cameras are available. */
+    emptyMessage?: string;
+    /**
+     * Show a built-in fullscreen toggle that fullscreens this feed's frame.
+     * Auto-hidden where the Fullscreen API is unavailable (e.g. iOS Safari,
+     * which only fullscreens the bare <video>). Default false.
+     */
+    enableFullscreen?: boolean;
+    /**
+     * Show a built-in Picture-in-Picture toggle for this feed's video.
+     * Auto-hidden where `document.pictureInPictureEnabled` is false. Default
+     * false.
+     */
+    enablePictureInPicture?: boolean;
+    /**
+     * Show a built-in per-camera quality control in the action bar: Auto plus
+     * the resolution presets (full / 3-4 / 1-2 / 1-4 of the operator-configured
+     * size), with the camera's effective resolution and a marker when the
+     * sidecar's adaptive machinery is throttling below the request. Requests
+     * can only lower quality; the resolution change arrives in-band over the
+     * existing WebRTC track (the video element is never remounted). Default
+     * false.
+     */
+    enableQualityControl?: boolean;
+    /**
+     * Consumer-injected action buttons, rendered left of the built-in
+     * fullscreen/PiP controls in the top-right action bar.
+     */
+    actions?: FeedAction[];
+    /**
+     * Consumer-injected action buttons rendered at the far end of the action
+     * bar, right of the built-in controls — the natural home for a close/remove
+     * button so it sits in the corner.
+     */
+    trailingActions?: FeedAction[];
+    /**
+     * Override how the displayed video stream is sourced for the resolved
+     * flightId. Omit (the default) to use the built-in `useKerbcastStream` —
+     * unchanged behaviour. When supplied it must be a stable reference passed
+     * consistently across renders (it is called as a hook); see
+     * {@link CameraStreamHook}.
+     */
+    useStream?: CameraStreamHook;
+}
+export interface CameraFeedHandle {
+    stepCamera(delta: number): void;
+    setZoomRate(rate: number): void;
+    setPanAxis(axis: "yaw" | "pitch", value: number): void;
+    nudgeZoom(deltaSign: number): void;
+    nudgePan(yawSign: number, pitchSign: number): void;
+}
+/**
+ * Display a live kerbcast camera feed with pan/zoom controls and camera picker.
+ * Must be rendered inside a `KerbcastProvider` unless the `client` prop is
+ * provided (which creates an implicit inner provider for this feed only).
+ */
+export declare const CameraFeed: import("react").ForwardRefExoticComponent<CameraFeedProps & import("react").RefAttributes<CameraFeedHandle>>;