openrtc-netcode-react 0.1.0

package/LICENSE

@@ -0,0 +1,92 @@
+Required Notice: Copyright (c) 2026 Bryant Hargreaves and OpenRTC contributors.
+Licensor Line of Business: OpenRTC realtime collaboration runtime, SDKs, developer services, and related tools (https://openrtc.app)
+
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms.  Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures.  Goods and services compete even when provided free of charge.  If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce [Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+**Affiliates** means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+**Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,21 @@
+# openrtc-netcode-react
+
+React context and hooks for `openrtc-netcode`.
+
+```tsx
+import { NetcodeProvider, usePeers, useNetVar } from 'openrtc-netcode-react';
+
+function Score() {
+  const peers = usePeers();
+  const [score, setScore] = useNetVar('score', 0);
+  return <button onClick={() => setScore(score + 1)}>{peers.length}: {score}</button>;
+}
+
+export function App() {
+  return (
+    <NetcodeProvider options={{ apiKey: 'pk_live_...' }}>
+      <Score />
+    </NetcodeProvider>
+  );
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { type PropsWithChildren } from 'react';
+import { type NetVarOptions, type NetcodeClient, type NetcodeEventName, type NetcodeEvents, type NetcodeLobby, type NetcodeMessage, type NetcodeMessageHandler, type NetcodeObjectChange, type NetcodeObjectState, type NetcodeOptions, type NetcodePeer, type NetcodePeerStats, type NetcodeVoicePeer } from 'openrtc-netcode';
+export interface NetcodeProviderProps extends PropsWithChildren {
+    client?: NetcodeClient;
+    options?: NetcodeOptions;
+    autoStart?: boolean;
+}
+export declare function NetcodeProvider({ client, options, autoStart, children }: NetcodeProviderProps): import("react").FunctionComponentElement<import("react").ProviderProps<NetcodeClient | null>>;
+export declare function useNetcode(): NetcodeClient;
+export declare function useLobby(): NetcodeLobby | null;
+export declare function usePeers(): NetcodePeer[];
+export declare function usePeerStats(): NetcodePeerStats[];
+export declare function useNetVar<T>(key: string, initial: T, options?: NetVarOptions): [T, (value: T) => Promise<void>];
+export declare function useNetworkObjects(kind?: string): NetcodeObjectState[];
+export declare function useNetcodeVoicePeers(): NetcodeVoicePeer[];
+export declare function useNetcodeEvent<K extends NetcodeEventName>(event: K, handler: (payload: NetcodeEvents[K]) => void): void;
+export declare function useNetcodeMessage<T = unknown>(type: string, handler: NetcodeMessageHandler<T>): void;
+export type { NetVarOptions, NetcodeClient, NetcodeEventName, NetcodeEvents, NetcodeLobby, NetcodeMessage, NetcodeMessageHandler, NetcodeObjectChange, NetcodeObjectState, NetcodeOptions, NetcodePeer, NetcodePeerStats, NetcodeVoicePeer, };

package/dist/index.js

@@ -0,0 +1,119 @@
+import { createContext, createElement, useCallback, useContext, useEffect, useMemo, useState, } from 'react';
+import { createNetcode, } from 'openrtc-netcode';
+const NetcodeContext = createContext(null);
+export function NetcodeProvider({ client, options, autoStart = true, children }) {
+    const resolvedClient = useMemo(() => client ?? createNetcode(options), [client, options]);
+    useEffect(() => {
+        if (!autoStart) {
+            return undefined;
+        }
+        void resolvedClient.start();
+        return () => {
+            void resolvedClient.stop();
+        };
+    }, [autoStart, resolvedClient]);
+    return createElement(NetcodeContext.Provider, { value: resolvedClient }, children);
+}
+export function useNetcode() {
+    const client = useContext(NetcodeContext);
+    if (!client) {
+        throw new Error('useNetcode must be used within a NetcodeProvider.');
+    }
+    return client;
+}
+export function useLobby() {
+    const client = useNetcode();
+    const [lobby, setLobby] = useState(() => client.lobby);
+    useEffect(() => client.on('lobby', setLobby), [client]);
+    return lobby;
+}
+export function usePeers() {
+    const client = useNetcode();
+    const [peers, setPeers] = useState(() => client.peers);
+    useEffect(() => {
+        const refresh = () => setPeers(client.peers);
+        const stops = [
+            client.on('peer:joined', refresh),
+            client.on('peer:left', refresh),
+            client.on('peer:connected', refresh),
+            client.on('peer:disconnected', refresh),
+            client.on('member:metadata', refresh),
+        ];
+        refresh();
+        return () => {
+            for (const stop of stops) {
+                stop();
+            }
+        };
+    }, [client]);
+    return peers;
+}
+export function usePeerStats() {
+    const client = useNetcode();
+    const [stats, setStats] = useState(() => client.peerStats);
+    useEffect(() => {
+        const refresh = () => setStats(client.peerStats);
+        const stops = [
+            client.on('peer:stats', refresh),
+            client.on('peer:joined', refresh),
+            client.on('peer:left', refresh),
+            client.on('peer:connected', refresh),
+            client.on('peer:disconnected', refresh),
+        ];
+        refresh();
+        return () => {
+            for (const stop of stops) {
+                stop();
+            }
+        };
+    }, [client]);
+    return stats;
+}
+export function useNetVar(key, initial, options) {
+    const client = useNetcode();
+    const netVar = useMemo(() => client.state.define(key, initial, options), [client, key]);
+    const [value, setValue] = useState(() => netVar.value);
+    useEffect(() => netVar.onChange((next) => setValue(next)), [netVar]);
+    const setNetVar = useCallback((next) => netVar.set(next), [netVar]);
+    return [value, setNetVar];
+}
+export function useNetworkObjects(kind) {
+    const client = useNetcode();
+    const [objects, setObjects] = useState(() => filterObjects(client.objects.list(), kind));
+    useEffect(() => {
+        const refresh = () => setObjects(filterObjects(client.objects.list(), kind));
+        refresh();
+        return client.objects.onChange(refresh);
+    }, [client, kind]);
+    return objects;
+}
+export function useNetcodeVoicePeers() {
+    const client = useNetcode();
+    const [peers, setPeers] = useState(() => client.voice.listPeers());
+    useEffect(() => {
+        const refresh = () => setPeers(client.voice.listPeers());
+        const stops = [
+            client.voice.on('peers', setPeers),
+            client.voice.on('peer:stream', refresh),
+            client.voice.on('peer:left', refresh),
+        ];
+        refresh();
+        return () => {
+            for (const stop of stops) {
+                stop();
+            }
+        };
+    }, [client]);
+    return peers;
+}
+export function useNetcodeEvent(event, handler) {
+    const client = useNetcode();
+    useEffect(() => client.on(event, handler), [client, event, handler]);
+}
+export function useNetcodeMessage(type, handler) {
+    const client = useNetcode();
+    useEffect(() => client.onMessage(type, handler), [client, type, handler]);
+}
+function filterObjects(objects, kind) {
+    return kind ? objects.filter((object) => object.kind === kind) : objects;
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "openrtc-netcode-react",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "sideEffects": false,
+  "description": "React context and hooks for openrtc-netcode.",
+  "keywords": [
+    "openrtc",
+    "netcode",
+    "react",
+    "multiplayer"
+  ],
+  "author": "Bryant Hargreaves",
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://openrtc.app",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bluestarburst/openrtc.git",
+    "directory": "packages/openrtc-netcode-react"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc",
+    "prepublishOnly": "pnpm run build",
+    "test": "vitest run tests",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "openrtc-netcode": "^0.1.0"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "happy-dom": "^20.5.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
+    "typescript": "^5.8.3",
+    "vitest": "^4.0.18"
+  }
+}