restream-sdk 0.1.3 → 0.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "restream-sdk",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Plug-and-play headless React hooks to add multi-platform restreaming (connect socials, go live, live chat + viewers) with zero client backend.",
   "type": "module",
   "main": "src/index.js",

package/src/core.js

@@ -4,7 +4,7 @@
 // (publisherSessionId) is produced by the client's existing stream and passed
 // into goLive() — this module never captures or publishes media itself.
 
-export const PLATFORMS = ["twitch", "kick", "youtube", "facebook", "instagram"];
+export const PLATFORMS = ["twitch", "kick", "youtube", "facebook", "instagram", "tiktok"];
 
 const TERMINAL_STATUS = new Set(["stopped", "failed", "ended", "error", "completed"]);
 
@@ -129,6 +129,22 @@ export class RestreamStudio extends EventTarget {
     return this.connections;
   }
 
+  /** Ask the backend which OAuth platforms are configured for this client. */
+  async listOAuthPlatforms() {
+    return this._req("GET", `/api/v1/connect/platforms${this._userQuery()}`);
+  }
+
+  /**
+   * List the channels the user connected inside their Restream account (the
+   * platforms Restream fans out to, e.g. TikTok). Requires a connected Restream
+   * account. Returns [{ id, platform, displayName, url, active }]; pass the chosen
+   * ids to goLive({ destinations: ["restream"], restreamChannels: [...] }).
+   */
+  async listRestreamChannels() {
+    const r = await this._req("GET", `/api/v1/connect/restream/channels${this._userQuery()}`);
+    return r?.channels || [];
+  }
+
   /** Open the hosted OAuth popup for a platform; resolves when connected (or the popup closes). */
   async connect(platform) {
     // Open the popup synchronously, inside the click's user-activation window —
@@ -175,7 +191,7 @@ export class RestreamStudio extends EventTarget {
    * @param {boolean} [opts.recording]
    * @param {string[]} [opts.trackNames]       tracks actually published, e.g. ["audio","video"]
    */
-  async goLive({ publisherSessionId, destinations, overlay, recording, trackNames } = {}) {
+  async goLive({ publisherSessionId, destinations, overlay, recording, trackNames, restreamChannels } = {}) {
     if (!publisherSessionId) throw new Error("publisherSessionId is required (from your existing stream session)");
     const body = {
       publisherSessionId,
@@ -184,6 +200,8 @@ export class RestreamStudio extends EventTarget {
       recording,
     };
     if (trackNames && trackNames.length) body.trackNames = trackNames;
+    // Per-platform selection for the "restream" fan-out bridge (channel ids or platform names).
+    if (restreamChannels && restreamChannels.length) body.restreamChannels = restreamChannels;
     if (this.publishableKey && this.userId) body.clientUserId = this.userId; // token mode binds server-side
     const job = await this._req("POST", "/api/v1/jobs", body);
     this.job = job;

package/src/react.js

@@ -40,6 +40,8 @@ export function useRestream(opts) {
     connect: useCallback((p) => studio.connect(p), [studio]),
     disconnect: useCallback((p) => studio.disconnect(p), [studio]),
     listConnections: useCallback(() => studio.listConnections(), [studio]),
+    listOAuthPlatforms: useCallback(() => studio.listOAuthPlatforms(), [studio]),
+    listRestreamChannels: useCallback(() => studio.listRestreamChannels(), [studio]),
     arm: useCallback((o) => studio.arm(o), [studio]),
     goLive: useCallback((o) => studio.goLive(o), [studio]),
     stopLive: useCallback(() => studio.stopLive(), [studio]),
@@ -51,8 +53,8 @@ export function useRestream(opts) {
 
 /** Convenience: just the social-connection state + actions. */
 export function useConnections(opts) {
-  const { connections, connect, disconnect, listConnections } = useRestream(opts);
-  return { connections, connect, disconnect, refresh: listConnections };
+  const { connections, connect, disconnect, listConnections, listOAuthPlatforms, listRestreamChannels } = useRestream(opts);
+  return { connections, connect, disconnect, refresh: listConnections, listOAuthPlatforms, listRestreamChannels };
 }
 
 /** Convenience: live chat (incoming comments + outbound send). Pass an existing studio. */

package/types/core.d.ts

@@ -2,6 +2,7 @@
 export { RestreamStudio, PLATFORMS } from "./index";
 export type {
   Platform,
+  RestreamChannel,
   RestreamOptions,
   Connection,
   Job,

package/types/index.d.ts

@@ -1,4 +1,13 @@
-export type Platform = "twitch" | "kick" | "youtube" | "facebook" | "instagram";
+export type Platform = "twitch" | "kick" | "youtube" | "facebook" | "instagram" | "tiktok" | "restream";
+
+/** A channel the user connected inside their Restream account (a fan-out target). */
+export interface RestreamChannel {
+  id: string;
+  platform: string;
+  displayName: string | null;
+  url: string | null;
+  active: boolean;
+}
 export const PLATFORMS: Platform[];
 
 export interface RestreamOptions {
@@ -60,6 +69,12 @@ export interface GoLiveParams {
   recording?: boolean;
   /** Track names actually published (e.g. ["audio","video"] or ["video"]). */
   trackNames?: string[];
+  /**
+   * For the "restream" fan-out destination: which Restream channels to relay to
+   * (channel ids from listRestreamChannels(), or platform names like "tiktok").
+   * Omit to use whichever channels are currently active in the Restream account.
+   */
+  restreamChannels?: string[];
 }
 
 export interface OverlayUpdate {
@@ -84,6 +99,8 @@ export class RestreamStudio extends EventTarget {
   on(type: "comments", cb: (c: Comment[]) => void): () => void;
   on(type: "error", cb: (e: Error) => void): () => void;
   listConnections(): Promise<Connection[]>;
+  listOAuthPlatforms(): Promise<{ platforms: Platform[]; frontendOrigin: string; redirectOrigin: string }>;
+  listRestreamChannels(): Promise<RestreamChannel[]>;
   connect(platform: Platform): Promise<{ platform: Platform; closed?: boolean }>;
   disconnect(platform: Platform): Promise<Connection[]>;
   arm(opts: { destinations: Platform[] }): unknown;
@@ -111,6 +128,8 @@ export interface UseRestream {
   connect(platform: Platform): Promise<{ platform: Platform; closed?: boolean }>;
   disconnect(platform: Platform): Promise<Connection[]>;
   listConnections(): Promise<Connection[]>;
+  listOAuthPlatforms(): Promise<{ platforms: Platform[]; frontendOrigin: string; redirectOrigin: string }>;
+  listRestreamChannels(): Promise<RestreamChannel[]>;
   arm(opts: { destinations: Platform[] }): unknown;
   goLive(opts: GoLiveParams): Promise<Job>;
   stopLive(): Promise<unknown>;
@@ -125,6 +144,8 @@ export function useConnections(opts: RestreamOptions): {
   connect(platform: Platform): Promise<{ platform: Platform; closed?: boolean }>;
   disconnect(platform: Platform): Promise<Connection[]>;
   refresh(): Promise<Connection[]>;
+  listOAuthPlatforms(): Promise<{ platforms: Platform[]; frontendOrigin: string; redirectOrigin: string }>;
+  listRestreamChannels(): Promise<RestreamChannel[]>;
 };
 export function useLiveChat(studio: RestreamStudio): { comments: Comment[]; send(message: string, platforms?: Platform[]): Promise<unknown> };
 export function useViewers(studio: RestreamStudio): ViewerCounts | null;