@reactor-team/js-sdk 2.9.3 → 2.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for describing the origin of the Work and
141
+ reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may accept and charge a
167
+ fee for acceptance of support, warranty, indemnity, or other liability
168
+ obligations and/or rights consistent with this License. However, in
169
+ accepting such obligations, You may act only on Your own behalf and
170
+ on Your sole responsibility, not on behalf of any other Contributor,
171
+ and only if You agree to indemnify, defend, and hold each Contributor
172
+ harmless for any liability incurred by, or claims asserted against,
173
+ such Contributor by reason of your accepting any such warranty or
174
+ additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2024-2026 Reactor Technologies, Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ Reactor JavaScript SDK
2
+ Copyright 2024-2026 Reactor Technologies, Inc.
3
+
4
+ This product includes software developed at
5
+ Reactor Technologies, Inc. (https://reactor.inc).
package/README.md CHANGED
@@ -1,20 +1,228 @@
1
- # Reactor Frontend SDK
1
+ # @reactor-team/js-sdk
2
2
 
3
- ## Overview
3
+ The official JavaScript/TypeScript SDK for [Reactor](https://reactor.inc), the developer platform for real-time world models.
4
4
 
5
- This is the frontend SDK for Reactor. It provides a set of tools and utilities to build frontend applications that can use the Reactor platform.
5
+ In a few lines of code you can connect a browser or Node app to a Reactor session over WebRTC, render live model video at 30–60 FPS, send typed commands to steer what generates, and receive structured messages back. The SDK ships a React API (`ReactorProvider`, `ReactorView`, `useReactor`, …) for browser apps, and an imperative `Reactor` class for everything else.
6
6
 
7
- There are two main ways to use the frontend SDK:
7
+ Full reference and guides live at **[docs.reactor.inc](https://docs.reactor.inc)**.
8
8
 
9
- 1. **Imperative API**: Use it in any TS/JS application.
10
- 2. **React API**: Use it in a React applications.
9
+ ---
11
10
 
12
- ## Building the SDK
11
+ ## Quickstart
12
+
13
+ The fastest path is `create-reactor-app`, which scaffolds a Next.js app with auth wired up:
14
+
15
+ ```bash
16
+ pnpm create reactor-app my-app
17
+ cd my-app && pnpm install && pnpm dev
18
+ ```
19
+
20
+ Or wire it up by hand. Exchange your API key for a short-lived JWT on the server, then mount `<ReactorProvider>` in the client:
21
+
22
+ ```ts
23
+ // app/api/token/route.ts
24
+ import { NextResponse } from "next/server";
25
+
26
+ export async function POST() {
27
+ const r = await fetch("https://api.reactor.inc/tokens", {
28
+ method: "POST",
29
+ headers: { "Reactor-API-Key": process.env.REACTOR_API_KEY! },
30
+ });
31
+ const { jwt } = await r.json();
32
+ return NextResponse.json({ jwt });
33
+ }
34
+ ```
35
+
36
+ ```tsx
37
+ // app/page.tsx
38
+ "use client";
39
+ import { use } from "react";
40
+ import { ReactorProvider, ReactorView } from "@reactor-team/js-sdk";
41
+
42
+ const tokenPromise = fetch("/api/token", { method: "POST" })
43
+ .then((r) => r.json())
44
+ .then(({ jwt }) => jwt);
45
+
46
+ export default function App() {
47
+ const token = use(tokenPromise);
48
+ return (
49
+ <ReactorProvider
50
+ modelName="your-model-name"
51
+ jwtToken={token}
52
+ connectOptions={{ autoConnect: true }}
53
+ >
54
+ <ReactorView className="w-full aspect-video" />
55
+ </ReactorProvider>
56
+ );
57
+ }
58
+ ```
59
+
60
+ See the [Quickstart](https://docs.reactor.inc/quickstart) and [Authentication](https://docs.reactor.inc/authentication) docs for the full walkthrough, including production auth patterns.
61
+
62
+ ---
63
+
64
+ ## React API
65
+
66
+ `<ReactorProvider>` owns the connection. Components, hooks, and the recording surfaces all read state and methods from its context. Don't call `connect()` unless `autoConnect` is `false`; the provider can manage it for you.
67
+
68
+ ### Display video
69
+
70
+ `<ReactorView>` binds to the model's `main_video` track and manages the underlying `<video>` element. Most models expose a single video output and you can drop it in unchanged:
71
+
72
+ ```tsx
73
+ <ReactorView className="w-full aspect-video" videoObjectFit="cover" />
74
+ ```
75
+
76
+ To play model audio alongside the video, set `audioTrack` to the track name declared by the model. To attach the stream to your own `<video>` element instead, read `tracks[name]` from `useReactor()`.
77
+
78
+ ### Send commands
79
+
80
+ Commands are the model's typed RPC surface (`set_prompt`, `set_image`, and any custom events declared in the model schema). The full catalog is in the [Model API Reference](https://docs.reactor.inc/model-api-reference/overview).
81
+
82
+ ```tsx
83
+ import { useReactor } from "@reactor-team/js-sdk";
84
+
85
+ function PromptInput() {
86
+ const { status, sendCommand } = useReactor((s) => ({
87
+ status: s.status,
88
+ sendCommand: s.sendCommand,
89
+ }));
90
+
91
+ return (
92
+ <button
93
+ disabled={status !== "ready"}
94
+ onClick={() => sendCommand("set_prompt", { prompt: "a forest at dawn" })}
95
+ >
96
+ Set prompt
97
+ </button>
98
+ );
99
+ }
100
+ ```
101
+
102
+ ### Publish webcam input
103
+
104
+ For video-to-video models, drop `<WebcamStream>` inside the provider and name the track the model expects. The component handles `getUserMedia`, lifecycle, and cleanup:
105
+
106
+ ```tsx
107
+ <ReactorProvider modelName="your-model-name" jwtToken={token}>
108
+ <ReactorView className="w-full aspect-video" />
109
+ <WebcamStream track="webcam" className="w-48 aspect-video" />
110
+ </ReactorProvider>
111
+ ```
112
+
113
+ ### Receive messages
114
+
115
+ Models emit structured messages back to your app, such as progress updates, state snapshots, or custom model events. Subscribe with `useReactorMessage`:
116
+
117
+ ```tsx
118
+ import { useReactorMessage } from "@reactor-team/js-sdk";
119
+
120
+ function FrameCounter() {
121
+ const [frame, setFrame] = useState(0);
122
+ useReactorMessage((msg) => {
123
+ if (msg.type === "state") setFrame(msg.data.current_frame);
124
+ });
125
+ return <div>Frame: {frame}</div>;
126
+ }
127
+ ```
128
+
129
+ ### Error handling
130
+
131
+ `useReactor((s) => s.lastError)` exposes the most recent `ReactorError`. Recoverable errors can be retried via `s.reconnect()`. Full code catalog: [`ReactorError`](https://docs.reactor.inc/api-reference/types#reactorerror).
132
+
133
+ ### Upload files
134
+
135
+ Bind an `<input type="file">` to the model with `uploadFile` and then pass the returned [`FileRef`](https://docs.reactor.inc/api-reference/types#fileref) into any command:
136
+
137
+ ```tsx
138
+ const { uploadFile, sendCommand } = useReactor((s) => s);
139
+
140
+ const ref = await uploadFile(file);
141
+ await sendCommand("set_image", { image: ref });
142
+ ```
143
+
144
+ ---
145
+
146
+ ## Imperative API
147
+
148
+ For non-React apps such as Electron shells, game engines, or Node scripts, use the `Reactor` class directly. It exposes the same surface as the React store, without the React glue:
149
+
150
+ ```ts
151
+ import { Reactor } from "@reactor-team/js-sdk";
152
+
153
+ const reactor = new Reactor({
154
+ apiUrl: "https://api.reactor.inc",
155
+ modelName: "your-model-name",
156
+ jwtToken: await fetchJwt(),
157
+ });
158
+
159
+ reactor.on("statusChange", (status) => console.log("status:", status));
160
+ reactor.on("message", (msg) => console.log("model:", msg));
161
+
162
+ await reactor.connect();
163
+
164
+ await reactor.sendCommand("set_prompt", { prompt: "a forest at dawn" });
165
+
166
+ const stream = reactor.getMediaStream("main_video");
167
+ videoEl.srcObject = stream;
168
+ ```
169
+
170
+ ---
171
+
172
+ ## Recording
173
+
174
+ Sessions are recorded as they stream. Ask the runtime for the last `N` seconds with `requestClip`, or the full session so far with `requestRecording`. Both resolve to a `Clip` value that you can pass to `<ClipPlayer>` for preview, or to `<ClipDownloadButton>` to save as MP4.
175
+
176
+ ```tsx
177
+ import { ClipPlayer, ClipDownloadButton } from "@reactor-team/js-sdk";
178
+ import type { Clip } from "@reactor-team/js-sdk";
179
+
180
+ function ClipModal({ clip, jwt }: { clip: Clip; jwt: string }) {
181
+ return (
182
+ <>
183
+ <ClipPlayer clip={clip} getJwt={() => jwt} />
184
+ <ClipDownloadButton clip={clip} getJwt={() => jwt} />
185
+ </>
186
+ );
187
+ }
188
+ ```
189
+
190
+ Capture a clip from anywhere inside the provider:
191
+
192
+ ```tsx
193
+ const reactor = useReactor((s) => s.internal.reactor);
194
+ const clip = await reactor.requestClip(10); // last 10 s
195
+ ```
196
+
197
+ `<ClipPlayer>` uses native HLS on Safari/iOS; install `hls.js` to support Chrome, Firefox, and Edge:
13
198
 
14
199
  ```bash
15
- pnpm build
200
+ pnpm add hls.js
16
201
  ```
17
202
 
18
- ## Documentation
203
+ Downloads are remuxed into a flat MP4 (`start_time=0`, faststart, `major_brand=isom`) under the hood so the resulting file uploads cleanly to Twitter, Instagram, TikTok, and YouTube without any extra setup on your side — the H.264 / AAC bitstream itself is passed through untouched.
204
+
205
+ Full walkthrough, error codes, and the headless `useClipDownload` hook: [Recordings](https://docs.reactor.inc/concepts/recordings).
206
+
207
+ ---
208
+
209
+ ## Typed model SDKs
210
+
211
+ For models with a published typed SDK, prefer [`@reactor-models/<name>`](https://www.npmjs.com/org/reactor-models). It re-exports everything here and adds typed commands, messages, and hooks for one specific model. Use this base SDK when the model doesn't have a typed package yet, or when you want to stay model-agnostic.
212
+
213
+ ---
214
+
215
+ ## API surface
216
+
217
+ | Surface | Where it lives |
218
+ | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
219
+ | `Reactor` | [Reactor class](https://docs.reactor.inc/api-reference/reactor-class) |
220
+ | `<ReactorProvider>`, `<ReactorView>`, `<WebcamStream>`, `<ReactorController>` | [React components](https://docs.reactor.inc/api-reference/react-components) |
221
+ | `useReactor`, `useReactorMessage`, `useStats` | [React hooks](https://docs.reactor.inc/api-reference/react-hooks) |
222
+ | `<ClipPlayer>`, `<ClipDownloadButton>`, `useClipDownload`, `RecordingClient`, `RecordingError`, `fetchPlaylist`, `parsePlaylist` | [Recordings](https://docs.reactor.inc/concepts/recordings) |
223
+
224
+ ---
225
+
226
+ ## License
19
227
 
20
- - [Getting Started](https://docs.reactor.inc)
228
+ [Apache 2.0](https://github.com/reactor-team/js-sdk/blob/main/LICENSE) © 2024-2026 Reactor Technologies, Inc.