@reactor-team/js-sdk 2.10.0 → 2.11.0

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
@@ -200,6 +200,8 @@ const clip = await reactor.requestClip(10); // last 10 s
200
200
  pnpm add hls.js
201
201
  ```
202
202
 
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
+
203
205
  Full walkthrough, error codes, and the headless `useClipDownload` hook: [Recordings](https://docs.reactor.inc/concepts/recordings).
204
206
 
205
207
  ---
@@ -223,4 +225,4 @@ For models with a published typed SDK, prefer [`@reactor-models/<name>`](https:/
223
225
 
224
226
  ## License
225
227
 
226
- MIT. © Reactor Technologies, Inc.
228
+ [Apache 2.0](https://github.com/reactor-team/js-sdk/blob/main/LICENSE) © 2024-2026 Reactor Technologies, Inc.
package/dist/index.d.mts CHANGED
@@ -178,6 +178,18 @@ interface ConnectionStats {
178
178
  }
179
179
  type ReactorEvent = "statusChanged" | "sessionIdChanged" | "message" | "runtimeMessage" | "trackReceived" | "error" | "sessionExpirationChanged" | "capabilitiesReceived" | "statsUpdate";
180
180
 
181
+ /**
182
+ * Lazy resolver for the Coordinator bearer token. The SDK calls this
183
+ * immediately before each authenticated HTTP request, so short-lived
184
+ * tokens (Clerk session JWTs, etc.) are refreshed transparently.
185
+ * Returning `""` suppresses the `Authorization` header entirely.
186
+ */
187
+ type JwtResolver = () => string | Promise<string>;
188
+ /** Static token, or a {@link JwtResolver} invoked per request. */
189
+ type JwtSource = string | JwtResolver;
190
+ /** Wrap a {@link JwtSource} into a {@link JwtResolver}. */
191
+ declare function normalizeJwtSource(source: JwtSource): JwtResolver;
192
+
181
193
  /**
182
194
  * Stateless primitives for the Reactor recording feature.
183
195
  *
@@ -190,8 +202,9 @@ type ReactorEvent = "statusChanged" | "sessionIdChanged" | "message" | "runtimeM
190
202
  * - HTTP helpers `fetchPlaylist` (deadline-driven polling) and
191
203
  * `parsePlaylist` (HLS `.m3u8` parser).
192
204
  * - The `downloadClipAsFile` helper that streams the referenced
193
- * fMP4 chunks and byte-concatenates them into a fragmented-MP4
194
- * Blob for browser download.
205
+ * fMP4 chunks, remuxes them into a flat social-media-ready MP4
206
+ * via `mp4box` (PTS=0, faststart, `major_brand=isom`), and
207
+ * returns a Blob for browser download.
195
208
  *
196
209
  * Stateful pieces (FIFO promise correlator, in-flight request
197
210
  * lifecycle, integration with Reactor's event bus) live in the
@@ -416,10 +429,17 @@ interface DownloadClipOptions {
416
429
  }) => void;
417
430
  }
418
431
  /**
419
- * Stream the chunks referenced by `clip.playlistUrl`, byte-concatenate
420
- * them into a fragmented-MP4 Blob, and (when `filename` is non-null)
421
- * trigger a browser-native `<a download>`. Pass `filename: null` to
422
- * skip the download trigger and just receive the Blob.
432
+ * Stream the chunks referenced by `clip.playlistUrl`, remux the
433
+ * assembled bytes into a flat social-media-ready MP4, and (when
434
+ * `filename` is non-null) trigger a browser-native `<a download>`.
435
+ * Pass `filename: null` to skip the download trigger and just
436
+ * receive the Blob.
437
+ *
438
+ * The remux step rewrites the container only — H.264 NAL units and
439
+ * AAC packets pass through unchanged — so `start_time=0`,
440
+ * `+faststart`, and `major_brand=isom` come for free without any
441
+ * re-encode cost. See {@link maybeRemux} for the fallback
442
+ * semantics on the rare parse failure.
423
443
  */
424
444
  declare function downloadClipAsFile(clip: Clip, filename?: string | null, options?: DownloadClipOptions): Promise<Blob>;
425
445
 
@@ -576,10 +596,18 @@ declare class Reactor {
576
596
  private tracks;
577
597
  private presetTracks?;
578
598
  private sessionResponse?;
599
+ private jwtResolver?;
579
600
  /** Per-Reactor recording client. See {@link RecordingClient}. */
580
601
  readonly recording: RecordingClient;
581
602
  constructor(options: Options);
582
603
  private eventListeners;
604
+ /**
605
+ * Returns the JWT resolver supplied to the most recent
606
+ * {@link connect} call, or `undefined` if none was set (pre-connect
607
+ * or local mode). Used by clip surfaces as a fallback when their
608
+ * own `getJwt` prop is omitted.
609
+ */
610
+ getJwtResolver(): JwtResolver | undefined;
583
611
  on(event: ReactorEvent, handler: EventHandler): void;
584
612
  off(event: ReactorEvent, handler: EventHandler): void;
585
613
  emit(event: ReactorEvent, ...args: any[]): void;
@@ -644,9 +672,12 @@ declare class Reactor {
644
672
  reconnect(options?: ConnectOptions): Promise<void>;
645
673
  /**
646
674
  * Connects to the coordinator, creates a session, then establishes
647
- * the transport using server-declared capabilities.
675
+ * the transport using server-declared capabilities. `jwtToken` may
676
+ * be a static string or a {@link JwtSource} resolver; pass a
677
+ * resolver when the token is short-lived so each Coordinator HTTP
678
+ * hop sees a fresh value.
648
679
  */
649
- connect(jwtToken?: string, options?: ConnectOptions): Promise<void>;
680
+ connect(jwtToken?: JwtSource, options?: ConnectOptions): Promise<void>;
650
681
  /**
651
682
  * Sets up event handlers for the transport client.
652
683
  * Each handler captures the client reference to ignore stale events.
@@ -683,11 +714,12 @@ interface ReactorState {
683
714
  lastError?: ReactorError;
684
715
  sessionId?: string;
685
716
  sessionExpiration?: number;
686
- jwtToken?: string;
717
+ /** Token source for Coordinator HTTP calls — see {@link JwtSource}. */
718
+ jwtToken?: JwtSource;
687
719
  }
688
720
  interface ReactorActions {
689
721
  sendCommand(command: string, data: any, scope?: MessageScope): Promise<void>;
690
- connect(jwtToken?: string, options?: ConnectOptions): Promise<void>;
722
+ connect(jwtToken?: JwtSource, options?: ConnectOptions): Promise<void>;
691
723
  disconnect(recoverable?: boolean): Promise<void>;
692
724
  publish(name: string, track: MediaStreamTrack): Promise<void>;
693
725
  unpublish(name: string): Promise<void>;
@@ -703,7 +735,8 @@ type ReactorStore = ReactorState & ReactorActions & {
703
735
  internal: ReactorInternalState;
704
736
  };
705
737
  interface ReactorInitializationProps extends Options {
706
- jwtToken?: string;
738
+ /** Token source for the underlying {@link Reactor} — see {@link JwtSource}. */
739
+ jwtToken?: JwtSource;
707
740
  }
708
741
 
709
742
  /**
@@ -714,12 +747,22 @@ interface ReactorConnectOptions extends ConnectOptions {
714
747
  /** Whether to automatically connect when the provider mounts. Default: false. */
715
748
  autoConnect?: boolean;
716
749
  }
717
- interface ReactorProviderProps extends ReactorInitializationProps {
750
+ interface ReactorProviderProps extends Omit<ReactorInitializationProps, "jwtToken"> {
718
751
  connectOptions?: ReactorConnectOptions;
752
+ /**
753
+ * Static JWT token. Use when you hold a long-lived SDK JWT (e.g.
754
+ * minted via `/tokens`). For short-lived tokens use {@link getJwt}.
755
+ */
719
756
  jwtToken?: string;
757
+ /**
758
+ * Lazy JWT resolver invoked immediately before each Coordinator
759
+ * HTTP request. Preferred for short-lived tokens. Wins over
760
+ * {@link jwtToken} when both are provided.
761
+ */
762
+ getJwt?: JwtResolver;
720
763
  children?: ReactNode;
721
764
  }
722
- declare function ReactorProvider({ children, connectOptions, jwtToken, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
765
+ declare function ReactorProvider({ children, connectOptions, jwtToken, getJwt, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
723
766
  declare function useReactorStore<T = ReactorStore>(selector: (state: ReactorStore) => T): T;
724
767
 
725
768
  interface ReactorViewProps {
@@ -790,9 +833,11 @@ declare function WebcamStream({ track, className, style, videoConstraints, showW
790
833
  * **does not require a ``ReactorProvider``** in the tree. It
791
834
  * operates on the ``Clip`` value alone, so it stays usable after
792
835
  * ``reactor.disconnect()`` and works with clips loaded from
793
- * fixtures, server logs, or any other source.
836
+ * fixtures, server logs, or any other source. When a
837
+ * ``ReactorProvider`` is mounted above, an omitted ``getJwt``
838
+ * inherits the provider's resolver.
794
839
  *
795
- * @example Compose with the download button:
840
+ * @example Compose with the download button (explicit `getJwt`):
796
841
  * ```tsx
797
842
  * <div>
798
843
  * <ClipPlayer clip={clip} getJwt={() => jwt} />
@@ -813,18 +858,16 @@ interface ClipPlayerProps {
813
858
  clip: Clip;
814
859
  /**
815
860
  * Lazy resolver for the Coordinator JWT used on the ``/clips``
816
- * manifest GET.
861
+ * manifest GET. Called at request time so token refreshes are
862
+ * picked up automatically.
817
863
  *
818
- * - **Production / Coordinator:** required. Should return the
819
- * same JWT your app already passes to ``ReactorProvider`` /
820
- * ``reactor.connect()``. Called at request time (not at render
821
- * time) so token refreshes are picked up automatically.
822
- * - **Local-dev / HttpRuntime:** omit — the local ``/clips``
823
- * endpoint serves manifests without auth.
864
+ * - **Production:** required outside a ``<ReactorProvider>``;
865
+ * optional inside one (inherits the provider's resolver).
866
+ * - **Local-dev (HttpRuntime):** omit — ``/clips`` is auth-free.
824
867
  *
825
- * The chunks referenced *inside* the manifest are S3 presigned
826
- * GETs (prod) or unauthenticated runtime URLs (local), and are
827
- * fetched without an ``Authorization`` header in either case.
868
+ * Chunk URLs inside the manifest are presigned (prod) or
869
+ * unauthenticated (local) and are fetched without
870
+ * ``Authorization`` in either case.
828
871
  */
829
872
  getJwt?: () => string | Promise<string>;
830
873
  /**
@@ -887,10 +930,11 @@ interface UseClipDownloadOptions {
887
930
  /**
888
931
  * Lazy resolver for the Coordinator JWT used on the ``/clips``
889
932
  * manifest GET. Called on every {@link download} invocation, so
890
- * token refreshes are picked up automatically. Omit in local-dev
891
- * mode (HttpRuntime has no auth on ``/clips``). See
892
- * {@link ClipPlayerProps.getJwt} for the production / local
893
- * distinction.
933
+ * token refreshes are picked up automatically.
934
+ *
935
+ * Optional inside a ``<ReactorProvider>`` (inherits the provider's
936
+ * resolver) and in local-dev mode. See
937
+ * {@link ClipPlayerProps.getJwt}.
894
938
  */
895
939
  getJwt?: () => string | Promise<string>;
896
940
  }
@@ -983,8 +1027,9 @@ interface ClipDownloadButtonProps {
983
1027
  /** The clip to download. */
984
1028
  clip: Clip;
985
1029
  /**
986
- * Lazy JWT resolver. See {@link ClipPlayerProps.getJwt} for the
987
- * production / local-dev distinction. Omit in local-dev mode.
1030
+ * Lazy JWT resolver. Optional inside a ``<ReactorProvider>``
1031
+ * (inherits the provider's resolver) and in local-dev mode. See
1032
+ * {@link ClipPlayerProps.getJwt}.
988
1033
  */
989
1034
  getJwt?: () => string | Promise<string>;
990
1035
  /** Filename for the saved MP4. Default ``"reactor-clip.mp4"``. */
@@ -1041,4 +1086,4 @@ declare function useReactorInternalMessage(handler: (message: any) => void): voi
1041
1086
  */
1042
1087
  declare function useStats(): ConnectionStats | undefined;
1043
1088
 
1044
- export { AbortError, type Capabilities, type Clip, ClipDownloadButton, type ClipDownloadButtonProps, type ClipDownloadState, type ClipFailedPayload, type ClipKind, ClipPlayer, type ClipPlayerProps, type ClipReadyPayload, type CommandCapability, ConflictError, type ConnectOptions, type ConnectionStats, type ConnectionTimings, DEFAULT_BASE_URL, DEFAULT_CLIP_REQUEST_TIMEOUT_MS, DEFAULT_PLAYLIST_POLL_SLACK_MS, type DownloadClipOptions, type FetchPlaylistOptions, FileRef, type MessageScope, type Options, type ParseClipOptions, Reactor, type ReactorConnectOptions, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorState$1 as ReactorState, type ReactorStatus, type ReactorStore, ReactorView, type ReactorViewProps, RecordingClient, type RecordingClientHost, RecordingError, RuntimeRecordingMessageType, type SessionResponse, type TrackCapability, type UseClipDownloadOptions, type UseClipDownloadResult, WebcamStream, type WebcamStreamProps, clipFromPayload, createPlayableManifestUrl, downloadClipAsFile, fetchPlaylist, isAbortError, parsePlaylist, rewriteUrlHost, useClipDownload, useReactor, useReactorInternalMessage, useReactorMessage, useReactorStore, useStats };
1089
+ export { AbortError, type Capabilities, type Clip, ClipDownloadButton, type ClipDownloadButtonProps, type ClipDownloadState, type ClipFailedPayload, type ClipKind, ClipPlayer, type ClipPlayerProps, type ClipReadyPayload, type CommandCapability, ConflictError, type ConnectOptions, type ConnectionStats, type ConnectionTimings, DEFAULT_BASE_URL, DEFAULT_CLIP_REQUEST_TIMEOUT_MS, DEFAULT_PLAYLIST_POLL_SLACK_MS, type DownloadClipOptions, type FetchPlaylistOptions, FileRef, type JwtResolver, type JwtSource, type MessageScope, type Options, type ParseClipOptions, Reactor, type ReactorConnectOptions, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorState$1 as ReactorState, type ReactorStatus, type ReactorStore, ReactorView, type ReactorViewProps, RecordingClient, type RecordingClientHost, RecordingError, RuntimeRecordingMessageType, type SessionResponse, type TrackCapability, type UseClipDownloadOptions, type UseClipDownloadResult, WebcamStream, type WebcamStreamProps, clipFromPayload, createPlayableManifestUrl, downloadClipAsFile, fetchPlaylist, isAbortError, normalizeJwtSource, parsePlaylist, rewriteUrlHost, useClipDownload, useReactor, useReactorInternalMessage, useReactorMessage, useReactorStore, useStats };
package/dist/index.d.ts CHANGED
@@ -178,6 +178,18 @@ interface ConnectionStats {
178
178
  }
179
179
  type ReactorEvent = "statusChanged" | "sessionIdChanged" | "message" | "runtimeMessage" | "trackReceived" | "error" | "sessionExpirationChanged" | "capabilitiesReceived" | "statsUpdate";
180
180
 
181
+ /**
182
+ * Lazy resolver for the Coordinator bearer token. The SDK calls this
183
+ * immediately before each authenticated HTTP request, so short-lived
184
+ * tokens (Clerk session JWTs, etc.) are refreshed transparently.
185
+ * Returning `""` suppresses the `Authorization` header entirely.
186
+ */
187
+ type JwtResolver = () => string | Promise<string>;
188
+ /** Static token, or a {@link JwtResolver} invoked per request. */
189
+ type JwtSource = string | JwtResolver;
190
+ /** Wrap a {@link JwtSource} into a {@link JwtResolver}. */
191
+ declare function normalizeJwtSource(source: JwtSource): JwtResolver;
192
+
181
193
  /**
182
194
  * Stateless primitives for the Reactor recording feature.
183
195
  *
@@ -190,8 +202,9 @@ type ReactorEvent = "statusChanged" | "sessionIdChanged" | "message" | "runtimeM
190
202
  * - HTTP helpers `fetchPlaylist` (deadline-driven polling) and
191
203
  * `parsePlaylist` (HLS `.m3u8` parser).
192
204
  * - The `downloadClipAsFile` helper that streams the referenced
193
- * fMP4 chunks and byte-concatenates them into a fragmented-MP4
194
- * Blob for browser download.
205
+ * fMP4 chunks, remuxes them into a flat social-media-ready MP4
206
+ * via `mp4box` (PTS=0, faststart, `major_brand=isom`), and
207
+ * returns a Blob for browser download.
195
208
  *
196
209
  * Stateful pieces (FIFO promise correlator, in-flight request
197
210
  * lifecycle, integration with Reactor's event bus) live in the
@@ -416,10 +429,17 @@ interface DownloadClipOptions {
416
429
  }) => void;
417
430
  }
418
431
  /**
419
- * Stream the chunks referenced by `clip.playlistUrl`, byte-concatenate
420
- * them into a fragmented-MP4 Blob, and (when `filename` is non-null)
421
- * trigger a browser-native `<a download>`. Pass `filename: null` to
422
- * skip the download trigger and just receive the Blob.
432
+ * Stream the chunks referenced by `clip.playlistUrl`, remux the
433
+ * assembled bytes into a flat social-media-ready MP4, and (when
434
+ * `filename` is non-null) trigger a browser-native `<a download>`.
435
+ * Pass `filename: null` to skip the download trigger and just
436
+ * receive the Blob.
437
+ *
438
+ * The remux step rewrites the container only — H.264 NAL units and
439
+ * AAC packets pass through unchanged — so `start_time=0`,
440
+ * `+faststart`, and `major_brand=isom` come for free without any
441
+ * re-encode cost. See {@link maybeRemux} for the fallback
442
+ * semantics on the rare parse failure.
423
443
  */
424
444
  declare function downloadClipAsFile(clip: Clip, filename?: string | null, options?: DownloadClipOptions): Promise<Blob>;
425
445
 
@@ -576,10 +596,18 @@ declare class Reactor {
576
596
  private tracks;
577
597
  private presetTracks?;
578
598
  private sessionResponse?;
599
+ private jwtResolver?;
579
600
  /** Per-Reactor recording client. See {@link RecordingClient}. */
580
601
  readonly recording: RecordingClient;
581
602
  constructor(options: Options);
582
603
  private eventListeners;
604
+ /**
605
+ * Returns the JWT resolver supplied to the most recent
606
+ * {@link connect} call, or `undefined` if none was set (pre-connect
607
+ * or local mode). Used by clip surfaces as a fallback when their
608
+ * own `getJwt` prop is omitted.
609
+ */
610
+ getJwtResolver(): JwtResolver | undefined;
583
611
  on(event: ReactorEvent, handler: EventHandler): void;
584
612
  off(event: ReactorEvent, handler: EventHandler): void;
585
613
  emit(event: ReactorEvent, ...args: any[]): void;
@@ -644,9 +672,12 @@ declare class Reactor {
644
672
  reconnect(options?: ConnectOptions): Promise<void>;
645
673
  /**
646
674
  * Connects to the coordinator, creates a session, then establishes
647
- * the transport using server-declared capabilities.
675
+ * the transport using server-declared capabilities. `jwtToken` may
676
+ * be a static string or a {@link JwtSource} resolver; pass a
677
+ * resolver when the token is short-lived so each Coordinator HTTP
678
+ * hop sees a fresh value.
648
679
  */
649
- connect(jwtToken?: string, options?: ConnectOptions): Promise<void>;
680
+ connect(jwtToken?: JwtSource, options?: ConnectOptions): Promise<void>;
650
681
  /**
651
682
  * Sets up event handlers for the transport client.
652
683
  * Each handler captures the client reference to ignore stale events.
@@ -683,11 +714,12 @@ interface ReactorState {
683
714
  lastError?: ReactorError;
684
715
  sessionId?: string;
685
716
  sessionExpiration?: number;
686
- jwtToken?: string;
717
+ /** Token source for Coordinator HTTP calls — see {@link JwtSource}. */
718
+ jwtToken?: JwtSource;
687
719
  }
688
720
  interface ReactorActions {
689
721
  sendCommand(command: string, data: any, scope?: MessageScope): Promise<void>;
690
- connect(jwtToken?: string, options?: ConnectOptions): Promise<void>;
722
+ connect(jwtToken?: JwtSource, options?: ConnectOptions): Promise<void>;
691
723
  disconnect(recoverable?: boolean): Promise<void>;
692
724
  publish(name: string, track: MediaStreamTrack): Promise<void>;
693
725
  unpublish(name: string): Promise<void>;
@@ -703,7 +735,8 @@ type ReactorStore = ReactorState & ReactorActions & {
703
735
  internal: ReactorInternalState;
704
736
  };
705
737
  interface ReactorInitializationProps extends Options {
706
- jwtToken?: string;
738
+ /** Token source for the underlying {@link Reactor} — see {@link JwtSource}. */
739
+ jwtToken?: JwtSource;
707
740
  }
708
741
 
709
742
  /**
@@ -714,12 +747,22 @@ interface ReactorConnectOptions extends ConnectOptions {
714
747
  /** Whether to automatically connect when the provider mounts. Default: false. */
715
748
  autoConnect?: boolean;
716
749
  }
717
- interface ReactorProviderProps extends ReactorInitializationProps {
750
+ interface ReactorProviderProps extends Omit<ReactorInitializationProps, "jwtToken"> {
718
751
  connectOptions?: ReactorConnectOptions;
752
+ /**
753
+ * Static JWT token. Use when you hold a long-lived SDK JWT (e.g.
754
+ * minted via `/tokens`). For short-lived tokens use {@link getJwt}.
755
+ */
719
756
  jwtToken?: string;
757
+ /**
758
+ * Lazy JWT resolver invoked immediately before each Coordinator
759
+ * HTTP request. Preferred for short-lived tokens. Wins over
760
+ * {@link jwtToken} when both are provided.
761
+ */
762
+ getJwt?: JwtResolver;
720
763
  children?: ReactNode;
721
764
  }
722
- declare function ReactorProvider({ children, connectOptions, jwtToken, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
765
+ declare function ReactorProvider({ children, connectOptions, jwtToken, getJwt, ...props }: ReactorProviderProps): react_jsx_runtime.JSX.Element;
723
766
  declare function useReactorStore<T = ReactorStore>(selector: (state: ReactorStore) => T): T;
724
767
 
725
768
  interface ReactorViewProps {
@@ -790,9 +833,11 @@ declare function WebcamStream({ track, className, style, videoConstraints, showW
790
833
  * **does not require a ``ReactorProvider``** in the tree. It
791
834
  * operates on the ``Clip`` value alone, so it stays usable after
792
835
  * ``reactor.disconnect()`` and works with clips loaded from
793
- * fixtures, server logs, or any other source.
836
+ * fixtures, server logs, or any other source. When a
837
+ * ``ReactorProvider`` is mounted above, an omitted ``getJwt``
838
+ * inherits the provider's resolver.
794
839
  *
795
- * @example Compose with the download button:
840
+ * @example Compose with the download button (explicit `getJwt`):
796
841
  * ```tsx
797
842
  * <div>
798
843
  * <ClipPlayer clip={clip} getJwt={() => jwt} />
@@ -813,18 +858,16 @@ interface ClipPlayerProps {
813
858
  clip: Clip;
814
859
  /**
815
860
  * Lazy resolver for the Coordinator JWT used on the ``/clips``
816
- * manifest GET.
861
+ * manifest GET. Called at request time so token refreshes are
862
+ * picked up automatically.
817
863
  *
818
- * - **Production / Coordinator:** required. Should return the
819
- * same JWT your app already passes to ``ReactorProvider`` /
820
- * ``reactor.connect()``. Called at request time (not at render
821
- * time) so token refreshes are picked up automatically.
822
- * - **Local-dev / HttpRuntime:** omit — the local ``/clips``
823
- * endpoint serves manifests without auth.
864
+ * - **Production:** required outside a ``<ReactorProvider>``;
865
+ * optional inside one (inherits the provider's resolver).
866
+ * - **Local-dev (HttpRuntime):** omit — ``/clips`` is auth-free.
824
867
  *
825
- * The chunks referenced *inside* the manifest are S3 presigned
826
- * GETs (prod) or unauthenticated runtime URLs (local), and are
827
- * fetched without an ``Authorization`` header in either case.
868
+ * Chunk URLs inside the manifest are presigned (prod) or
869
+ * unauthenticated (local) and are fetched without
870
+ * ``Authorization`` in either case.
828
871
  */
829
872
  getJwt?: () => string | Promise<string>;
830
873
  /**
@@ -887,10 +930,11 @@ interface UseClipDownloadOptions {
887
930
  /**
888
931
  * Lazy resolver for the Coordinator JWT used on the ``/clips``
889
932
  * manifest GET. Called on every {@link download} invocation, so
890
- * token refreshes are picked up automatically. Omit in local-dev
891
- * mode (HttpRuntime has no auth on ``/clips``). See
892
- * {@link ClipPlayerProps.getJwt} for the production / local
893
- * distinction.
933
+ * token refreshes are picked up automatically.
934
+ *
935
+ * Optional inside a ``<ReactorProvider>`` (inherits the provider's
936
+ * resolver) and in local-dev mode. See
937
+ * {@link ClipPlayerProps.getJwt}.
894
938
  */
895
939
  getJwt?: () => string | Promise<string>;
896
940
  }
@@ -983,8 +1027,9 @@ interface ClipDownloadButtonProps {
983
1027
  /** The clip to download. */
984
1028
  clip: Clip;
985
1029
  /**
986
- * Lazy JWT resolver. See {@link ClipPlayerProps.getJwt} for the
987
- * production / local-dev distinction. Omit in local-dev mode.
1030
+ * Lazy JWT resolver. Optional inside a ``<ReactorProvider>``
1031
+ * (inherits the provider's resolver) and in local-dev mode. See
1032
+ * {@link ClipPlayerProps.getJwt}.
988
1033
  */
989
1034
  getJwt?: () => string | Promise<string>;
990
1035
  /** Filename for the saved MP4. Default ``"reactor-clip.mp4"``. */
@@ -1041,4 +1086,4 @@ declare function useReactorInternalMessage(handler: (message: any) => void): voi
1041
1086
  */
1042
1087
  declare function useStats(): ConnectionStats | undefined;
1043
1088
 
1044
- export { AbortError, type Capabilities, type Clip, ClipDownloadButton, type ClipDownloadButtonProps, type ClipDownloadState, type ClipFailedPayload, type ClipKind, ClipPlayer, type ClipPlayerProps, type ClipReadyPayload, type CommandCapability, ConflictError, type ConnectOptions, type ConnectionStats, type ConnectionTimings, DEFAULT_BASE_URL, DEFAULT_CLIP_REQUEST_TIMEOUT_MS, DEFAULT_PLAYLIST_POLL_SLACK_MS, type DownloadClipOptions, type FetchPlaylistOptions, FileRef, type MessageScope, type Options, type ParseClipOptions, Reactor, type ReactorConnectOptions, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorState$1 as ReactorState, type ReactorStatus, type ReactorStore, ReactorView, type ReactorViewProps, RecordingClient, type RecordingClientHost, RecordingError, RuntimeRecordingMessageType, type SessionResponse, type TrackCapability, type UseClipDownloadOptions, type UseClipDownloadResult, WebcamStream, type WebcamStreamProps, clipFromPayload, createPlayableManifestUrl, downloadClipAsFile, fetchPlaylist, isAbortError, parsePlaylist, rewriteUrlHost, useClipDownload, useReactor, useReactorInternalMessage, useReactorMessage, useReactorStore, useStats };
1089
+ export { AbortError, type Capabilities, type Clip, ClipDownloadButton, type ClipDownloadButtonProps, type ClipDownloadState, type ClipFailedPayload, type ClipKind, ClipPlayer, type ClipPlayerProps, type ClipReadyPayload, type CommandCapability, ConflictError, type ConnectOptions, type ConnectionStats, type ConnectionTimings, DEFAULT_BASE_URL, DEFAULT_CLIP_REQUEST_TIMEOUT_MS, DEFAULT_PLAYLIST_POLL_SLACK_MS, type DownloadClipOptions, type FetchPlaylistOptions, FileRef, type JwtResolver, type JwtSource, type MessageScope, type Options, type ParseClipOptions, Reactor, type ReactorConnectOptions, ReactorController, type ReactorControllerProps, type ReactorError, type ReactorEvent, ReactorProvider, type ReactorState$1 as ReactorState, type ReactorStatus, type ReactorStore, ReactorView, type ReactorViewProps, RecordingClient, type RecordingClientHost, RecordingError, RuntimeRecordingMessageType, type SessionResponse, type TrackCapability, type UseClipDownloadOptions, type UseClipDownloadResult, WebcamStream, type WebcamStreamProps, clipFromPayload, createPlayableManifestUrl, downloadClipAsFile, fetchPlaylist, isAbortError, normalizeJwtSource, parsePlaylist, rewriteUrlHost, useClipDownload, useReactor, useReactorInternalMessage, useReactorMessage, useReactorStore, useStats };