@rivi-software/radiotools-sdk-react 0.0.0-stage → 0.2.2

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @rivi-software/radiotools-sdk-react
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+React hooks for the RadioTools listener API, wrapping [`@rivi-software/radiotools-sdk`](../sdk-typescript). Generated from `@rivi-software/radiotools-contract`; do not edit `src/hooks.generated.ts` by hand.
+
+## Install
+
+```bash
+npm install @rivi-software/radiotools-sdk-react @rivi-software/radiotools-sdk
+```
+
+Requires React 18 or newer.
+
+## Usage
+
+```tsx
+import { createStationClient } from "@rivi-software/radiotools-sdk";
+import { useGetNowPlaying } from "@rivi-software/radiotools-sdk-react";
+
+const client = createStationClient({ baseUrl, stationSlug, apiToken });
+
+export function NowPlaying() {
+  const { data, error, loading, refresh } = useGetNowPlaying(client);
+  if (loading) return <p>Loading…</p>;
+  if (error) return <p>{error.message}</p>;
+  return <p>{data?.track?.title}</p>;
+}
+```
+
+Create the client once, outside components or in a memo, so the hooks keep a stable reference.
+
+## Hooks
+
+`useGetStation`, `useGetCurrentBroadcast`, `useGetNowPlaying`, `useGetWeather`, `useGetTraffic`, `useRecommendedPollInterval`. Each returns `{ data, error, loading, refresh }`.
+
+For anything else, call the client directly.

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@rivi-software/radiotools-sdk-react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.2",
+  "description": "React hooks for @rivi-software/radiotools-sdk (generated from @rivi-software/radiotools-contract)",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "files": [
+    "src"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@rivi-software/radiotools-sdk": "workspace:*"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "devDependencies": {
+    "@types/react": "19.3.0",
+    "react": "19.3.0",
+    "typescript": "5.9.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rivi-software/radiotools-sdk.git",
+    "directory": "packages/sdk-react"
+  }
+}

package/src/hooks.generated.ts

@@ -0,0 +1,74 @@
+/** Generated by @rivi-software/radiotools-sdk-generator — do not edit by hand. */
+import { useCallback, useEffect, useRef, useState } from "react";
+import type { StationClient } from "@rivi-software/radiotools-sdk";
+
+type QueryState<T> = {
+  data: T | undefined;
+  error: Error | undefined;
+  loading: boolean;
+  refresh: () => void;
+};
+
+function useStationQuery<T>(
+  client: StationClient,
+  _method: string,
+  read: () => Promise<T>,
+): QueryState<T> {
+  const [data, setData] = useState<T | undefined>(undefined);
+  const [error, setError] = useState<Error | undefined>(undefined);
+  const [loading, setLoading] = useState(true);
+  const mounted = useRef(true);
+
+  const refresh = useCallback(() => {
+    setLoading(true);
+    void read()
+      .then((value) => {
+        if (!mounted.current) return;
+        setData(value);
+        setError(undefined);
+      })
+      .catch((cause: unknown) => {
+        if (!mounted.current) return;
+        setError(cause instanceof Error ? cause : new Error(String(cause)));
+      })
+      .finally(() => {
+        if (mounted.current) setLoading(false);
+      });
+  }, [read]);
+
+  useEffect(() => {
+    mounted.current = true;
+    refresh();
+    return () => {
+      mounted.current = false;
+    };
+  }, [refresh]);
+
+  return { data, error, loading, refresh };
+}
+
+export function useRecommendedPollInterval(client: StationClient): QueryState<number> {
+  return useStationQuery(client, "recommendedPollIntervalMs", () =>
+    client.recommendedPollIntervalMs(),
+  );
+}
+
+export function useGetStation(client: StationClient) {
+  return useStationQuery(client, "getStation", () => client.getStation());
+}
+
+export function useGetCurrentBroadcast(client: StationClient) {
+  return useStationQuery(client, "getCurrentBroadcast", () => client.getCurrentBroadcast());
+}
+
+export function useGetNowPlaying(client: StationClient) {
+  return useStationQuery(client, "getNowPlaying", () => client.getNowPlaying());
+}
+
+export function useGetWeather(client: StationClient) {
+  return useStationQuery(client, "getWeather", () => client.getWeather());
+}
+
+export function useGetTraffic(client: StationClient) {
+  return useStationQuery(client, "getTraffic", () => client.getTraffic());
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./hooks.generated";