@reactor-team/js-sdk 1.0.19 → 1.0.22

package/README.md

@@ -9,6 +9,41 @@ There are two main ways to use the frontend SDK:
 1. **Imperative API**: Use it in any TS/JS application.
 2. **React API**: Use it in a React applications.
 
+## Setup
+
+### Fetching Protobuf Types
+
+The SDK uses generated TypeScript types from the [reactor-proto](https://github.com/reactor-team/reactor-proto) repository. These are fetched from GitHub releases and placed in `src/generated/`.
+
+1. Set your GitHub token (required for private repo access):
+
+```bash
+export GH_TOKEN=your_github_token
+```
+
+2. Fetch the protobuf types:
+
+```bash
+pnpm proto
+```
+
+This will download the types matching the version specified in `package.json` under `protobufsVersion`.
+
+### Updating Protobuf Version
+
+To update to a new protobuf version:
+
+1. Update `protobufsVersion` in `package.json` to the new semver (e.g., `"0.3.4"`)
+2. Run `pnpm proto` to fetch the new types
+
+### Cleaning Generated Files
+
+To remove the generated protobuf types:
+
+```bash
+pnpm clean
+```
+
 ## Building the SDK
 
 Set up the environment variables:
@@ -21,6 +56,14 @@ Then add your NPM_TOKEN to the .env file.
 
 Build the SDK:
 
+```bash
+pnpm build
+```
+
+## Publishing
+
+To publish the SDK:
+
 ```bash
 ./publish_package.sh
 ```

package/dist/index.d.mts

@@ -1,31 +1,8 @@
-import z$1, { z } from 'zod';
+import { z } from 'zod';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
-import { RemoteVideoTrack } from 'livekit-client';
-
-/**
- * Internal types for the Reactor SDK.
- */
-
-declare const WaitingInfoDataSchema: z.ZodObject<{
-    position: z.ZodOptional<z.ZodNumber>;
-    estimatedWaitTime: z.ZodOptional<z.ZodNumber>;
-    averageWaitTime: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-declare const SessionExpirationDataSchema: z.ZodObject<{
-    expire: z.ZodNumber;
-}, z.core.$strip>;
-declare const ReactorAuthSchema: z.ZodObject<{
-    insecureApiKey: z.ZodOptional<z.ZodString>;
-    jwtToken: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type ReactorAuth = z.infer<typeof ReactorAuthSchema>;
 
 type ReactorStatus = "disconnected" | "connecting" | "waiting" | "ready";
-interface ReactorWaitingInfo extends z$1.infer<typeof WaitingInfoDataSchema> {
-}
-interface ReactorSessionExpiration extends z$1.infer<typeof SessionExpirationDataSchema> {
-}
 interface ReactorError {
     code: string;
     message: string;
@@ -36,15 +13,14 @@ interface ReactorError {
 }
 interface ReactorState$1 {
     status: ReactorStatus;
-    waitingInfo?: ReactorWaitingInfo;
     lastError?: ReactorError;
 }
-type ReactorEvent = "statusChanged" | "waitingInfoChanged" | "newMessage" | "fps" | "streamChanged" | "error" | "sessionExpirationChanged";
+type ReactorEvent = "statusChanged" | "sessionIdChanged" | "newMessage" | "streamChanged" | "error" | "sessionExpirationChanged";
 
+declare const PROD_COORDINATOR_URL = "https://api.reactor.inc";
 declare const OptionsSchema: z.ZodObject<{
     coordinatorUrl: z.ZodDefault<z.ZodString>;
     modelName: z.ZodString;
-    queueing: z.ZodDefault<z.ZodBoolean>;
     local: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 type Options = z.input<typeof OptionsSchema>;
@@ -55,12 +31,10 @@ declare class Reactor {
     private status;
     private coordinatorUrl;
     private lastError?;
-    private waitingInfo?;
-    private modelName;
-    private modelVersion;
-    private queueing;
+    private model;
     private sessionExpiration?;
     private local;
+    private sessionId?;
     constructor(options: Options);
     private eventListeners;
     on(event: ReactorEvent, handler: EventHandler): void;
@@ -72,51 +46,48 @@ declare class Reactor {
      * @param message The message to send to the machine.
      * @throws Error if not in ready state
      */
-    sendMessage(message: any): Promise<void>;
+    sendCommand(command: string, data: any): Promise<void>;
     /**
-     * Public method to publish a video stream to the machine.
-     * @param videoStream The video stream to send to the machine.
+     * Public method to publish a track to the machine.
+     * @param track The track to send to the machine.
      */
-    publishVideoStream(videoStream: MediaStream): Promise<void>;
+    publishTrack(track: MediaStreamTrack): Promise<void>;
     /**
-     * Public method to unpublish video stream to the machine.
-     * This unpublishes the video track that was previously sent.
+     * Public method to unpublish the currently published track.
      */
-    unpublishVideoStream(): Promise<void>;
+    unpublishTrack(): Promise<void>;
     /**
-     * Connects to the machine via LiveKit and waits for the gpu machine to be ready.
-     * Once the machine is ready, the Reactor will establish the LiveKit connection.
-     * @param livekitJwtToken The JWT token for LiveKit authentication
-     * @param livekitWsUrl The WebSocket URL for LiveKit connection
+     * Public method for reconnecting to an existing session, that may have been interrupted but can be recovered.
      */
-    private connectToGPUMachine;
+    reconnect(): Promise<void>;
     /**
      * Connects to the coordinator and waits for a GPU to be assigned.
-     * Once a GPU is assigned, the Reactor will connect to the gpu machine via LiveKit.
+     * Once a GPU is assigned, the Reactor will connect to the gpu machine via WebRTC.
      * If no authentication is provided and not in local mode, an error is thrown.
      */
-    connect(auth?: ReactorAuth): Promise<void>;
+    connect(jwtToken?: string): Promise<void>;
+    /**
+     * Sets up event handlers for the machine client.
+     */
+    private setupMachineClientHandlers;
     /**
      * Disconnects from the coordinator and the gpu machine.
      * Ensures cleanup completes even if individual disconnections fail.
      */
-    disconnect(): Promise<void>;
+    disconnect(recoverable?: boolean): Promise<void>;
+    private setSessionId;
+    getSessionId(): string | undefined;
     private setStatus;
-    private setWaitingInfo;
+    getStatus(): ReactorStatus;
     /**
      * Set the session expiration time.
      * @param newSessionExpiration The new session expiration time in seconds.
      */
     private setSessionExpiration;
-    getStatus(): ReactorStatus;
     /**
      * Get the current state including status, error, and waiting info
      */
     getState(): ReactorState$1;
-    /**
-     * Get waiting information when status is 'waiting'
-     */
-    getWaitingInfo(): ReactorWaitingInfo | undefined;
     /**
      * Get the last error that occurred
      */
@@ -129,20 +100,20 @@ declare class Reactor {
 
 interface ReactorState {
     status: ReactorStatus;
-    videoTrack: RemoteVideoTrack | null;
-    fps?: number;
-    waitingInfo?: ReactorWaitingInfo;
+    videoTrack: MediaStreamTrack | null;
     lastError?: ReactorError;
+    sessionId?: string;
     sessionExpiration?: number;
     insecureApiKey?: string;
     jwtToken?: string;
 }
 interface ReactorActions {
-    sendMessage(message: any): Promise<void>;
-    connect(auth?: ReactorAuth): Promise<void>;
-    disconnect(): Promise<void>;
+    sendCommand(command: string, data: any): Promise<void>;
+    connect(jwtToken?: string): Promise<void>;
+    disconnect(recoverable?: boolean): Promise<void>;
     publishVideoStream(stream: MediaStream): Promise<void>;
     unpublishVideoStream(): Promise<void>;
+    reconnect(): Promise<void>;
 }
 interface ReactorInternalState {
     reactor: Reactor;
@@ -151,17 +122,15 @@ type ReactorStore = ReactorState & ReactorActions & {
     internal: ReactorInternalState;
 };
 interface ReactorInitializationProps extends Options {
-    insecureApiKey?: string;
     jwtToken?: string;
 }
 
 interface ReactorProviderProps extends ReactorInitializationProps {
     autoConnect?: boolean;
-    insecureApiKey?: string;
     jwtToken?: string;
     children: ReactNode;
 }
-declare function ReactorProvider({ children, autoConnect, insecureApiKey, jwtToken, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
+declare function ReactorProvider({ children, autoConnect, jwtToken, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
 declare function useReactorStore<T = ReactorStore>(selector: (state: ReactorStore) => T): T;
 
 interface ReactorViewProps {
@@ -202,4 +171,4 @@ declare function useReactor<T>(selector: (state: ReactorStore) => T): T;
  */
 declare function useReactorMessage(handler: (message: any) => void): void;
 
-export { type Options, Reactor, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorSessionExpiration, type ReactorState$1 as ReactorState, type ReactorStatus, ReactorView, type ReactorViewProps, type ReactorWaitingInfo, WebcamStream, useReactor, useReactorMessage, useReactorStore };
+export { type Options, PROD_COORDINATOR_URL, Reactor, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorState$1 as ReactorState, type ReactorStatus, ReactorView, type ReactorViewProps, WebcamStream, useReactor, useReactorMessage, useReactorStore };

package/dist/index.d.ts

@@ -1,31 +1,8 @@
-import z$1, { z } from 'zod';
+import { z } from 'zod';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React, { ReactNode } from 'react';
-import { RemoteVideoTrack } from 'livekit-client';
-
-/**
- * Internal types for the Reactor SDK.
- */
-
-declare const WaitingInfoDataSchema: z.ZodObject<{
-    position: z.ZodOptional<z.ZodNumber>;
-    estimatedWaitTime: z.ZodOptional<z.ZodNumber>;
-    averageWaitTime: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-declare const SessionExpirationDataSchema: z.ZodObject<{
-    expire: z.ZodNumber;
-}, z.core.$strip>;
-declare const ReactorAuthSchema: z.ZodObject<{
-    insecureApiKey: z.ZodOptional<z.ZodString>;
-    jwtToken: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type ReactorAuth = z.infer<typeof ReactorAuthSchema>;
 
 type ReactorStatus = "disconnected" | "connecting" | "waiting" | "ready";
-interface ReactorWaitingInfo extends z$1.infer<typeof WaitingInfoDataSchema> {
-}
-interface ReactorSessionExpiration extends z$1.infer<typeof SessionExpirationDataSchema> {
-}
 interface ReactorError {
     code: string;
     message: string;
@@ -36,15 +13,14 @@ interface ReactorError {
 }
 interface ReactorState$1 {
     status: ReactorStatus;
-    waitingInfo?: ReactorWaitingInfo;
     lastError?: ReactorError;
 }
-type ReactorEvent = "statusChanged" | "waitingInfoChanged" | "newMessage" | "fps" | "streamChanged" | "error" | "sessionExpirationChanged";
+type ReactorEvent = "statusChanged" | "sessionIdChanged" | "newMessage" | "streamChanged" | "error" | "sessionExpirationChanged";
 
+declare const PROD_COORDINATOR_URL = "https://api.reactor.inc";
 declare const OptionsSchema: z.ZodObject<{
     coordinatorUrl: z.ZodDefault<z.ZodString>;
     modelName: z.ZodString;
-    queueing: z.ZodDefault<z.ZodBoolean>;
     local: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 type Options = z.input<typeof OptionsSchema>;
@@ -55,12 +31,10 @@ declare class Reactor {
     private status;
     private coordinatorUrl;
     private lastError?;
-    private waitingInfo?;
-    private modelName;
-    private modelVersion;
-    private queueing;
+    private model;
     private sessionExpiration?;
     private local;
+    private sessionId?;
     constructor(options: Options);
     private eventListeners;
     on(event: ReactorEvent, handler: EventHandler): void;
@@ -72,51 +46,48 @@ declare class Reactor {
      * @param message The message to send to the machine.
      * @throws Error if not in ready state
      */
-    sendMessage(message: any): Promise<void>;
+    sendCommand(command: string, data: any): Promise<void>;
     /**
-     * Public method to publish a video stream to the machine.
-     * @param videoStream The video stream to send to the machine.
+     * Public method to publish a track to the machine.
+     * @param track The track to send to the machine.
      */
-    publishVideoStream(videoStream: MediaStream): Promise<void>;
+    publishTrack(track: MediaStreamTrack): Promise<void>;
     /**
-     * Public method to unpublish video stream to the machine.
-     * This unpublishes the video track that was previously sent.
+     * Public method to unpublish the currently published track.
      */
-    unpublishVideoStream(): Promise<void>;
+    unpublishTrack(): Promise<void>;
     /**
-     * Connects to the machine via LiveKit and waits for the gpu machine to be ready.
-     * Once the machine is ready, the Reactor will establish the LiveKit connection.
-     * @param livekitJwtToken The JWT token for LiveKit authentication
-     * @param livekitWsUrl The WebSocket URL for LiveKit connection
+     * Public method for reconnecting to an existing session, that may have been interrupted but can be recovered.
      */
-    private connectToGPUMachine;
+    reconnect(): Promise<void>;
     /**
      * Connects to the coordinator and waits for a GPU to be assigned.
-     * Once a GPU is assigned, the Reactor will connect to the gpu machine via LiveKit.
+     * Once a GPU is assigned, the Reactor will connect to the gpu machine via WebRTC.
      * If no authentication is provided and not in local mode, an error is thrown.
      */
-    connect(auth?: ReactorAuth): Promise<void>;
+    connect(jwtToken?: string): Promise<void>;
+    /**
+     * Sets up event handlers for the machine client.
+     */
+    private setupMachineClientHandlers;
     /**
      * Disconnects from the coordinator and the gpu machine.
      * Ensures cleanup completes even if individual disconnections fail.
      */
-    disconnect(): Promise<void>;
+    disconnect(recoverable?: boolean): Promise<void>;
+    private setSessionId;
+    getSessionId(): string | undefined;
     private setStatus;
-    private setWaitingInfo;
+    getStatus(): ReactorStatus;
     /**
      * Set the session expiration time.
      * @param newSessionExpiration The new session expiration time in seconds.
      */
     private setSessionExpiration;
-    getStatus(): ReactorStatus;
     /**
      * Get the current state including status, error, and waiting info
      */
     getState(): ReactorState$1;
-    /**
-     * Get waiting information when status is 'waiting'
-     */
-    getWaitingInfo(): ReactorWaitingInfo | undefined;
     /**
      * Get the last error that occurred
      */
@@ -129,20 +100,20 @@ declare class Reactor {
 
 interface ReactorState {
     status: ReactorStatus;
-    videoTrack: RemoteVideoTrack | null;
-    fps?: number;
-    waitingInfo?: ReactorWaitingInfo;
+    videoTrack: MediaStreamTrack | null;
     lastError?: ReactorError;
+    sessionId?: string;
     sessionExpiration?: number;
     insecureApiKey?: string;
     jwtToken?: string;
 }
 interface ReactorActions {
-    sendMessage(message: any): Promise<void>;
-    connect(auth?: ReactorAuth): Promise<void>;
-    disconnect(): Promise<void>;
+    sendCommand(command: string, data: any): Promise<void>;
+    connect(jwtToken?: string): Promise<void>;
+    disconnect(recoverable?: boolean): Promise<void>;
     publishVideoStream(stream: MediaStream): Promise<void>;
     unpublishVideoStream(): Promise<void>;
+    reconnect(): Promise<void>;
 }
 interface ReactorInternalState {
     reactor: Reactor;
@@ -151,17 +122,15 @@ type ReactorStore = ReactorState & ReactorActions & {
     internal: ReactorInternalState;
 };
 interface ReactorInitializationProps extends Options {
-    insecureApiKey?: string;
     jwtToken?: string;
 }
 
 interface ReactorProviderProps extends ReactorInitializationProps {
     autoConnect?: boolean;
-    insecureApiKey?: string;
     jwtToken?: string;
     children: ReactNode;
 }
-declare function ReactorProvider({ children, autoConnect, insecureApiKey, jwtToken, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
+declare function ReactorProvider({ children, autoConnect, jwtToken, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
 declare function useReactorStore<T = ReactorStore>(selector: (state: ReactorStore) => T): T;
 
 interface ReactorViewProps {
@@ -202,4 +171,4 @@ declare function useReactor<T>(selector: (state: ReactorStore) => T): T;
  */
 declare function useReactorMessage(handler: (message: any) => void): void;
 
-export { type Options, Reactor, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorSessionExpiration, type ReactorState$1 as ReactorState, type ReactorStatus, ReactorView, type ReactorViewProps, type ReactorWaitingInfo, WebcamStream, useReactor, useReactorMessage, useReactorStore };
+export { type Options, PROD_COORDINATOR_URL, Reactor, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorState$1 as ReactorState, type ReactorStatus, ReactorView, type ReactorViewProps, WebcamStream, useReactor, useReactorMessage, useReactorStore };