@thestatic-tv/dcl-sdk 2.2.9 → 2.3.0-dev.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import ReactEcs from '@dcl/sdk/react-ecs';
+
 /**
  * Player identity data from DCL
  */
@@ -203,6 +205,111 @@ interface ChatUIConfig {
      */
     fontScale?: number;
 }
+/**
+ * Stream channel data from the API
+ */
+interface StreamData {
+    hasChannel: boolean;
+    channelId: string | null;
+    channelName?: string;
+    isLive: boolean;
+    hlsUrl: string | null;
+    rtmpUrl?: string | null;
+    streamKey?: string | null;
+    currentViewers: number;
+    sparksBalance: number;
+    tier?: string;
+    /** True if user can claim the one-time streaming trial */
+    trialAvailable?: boolean;
+    /** Number of Sparks included in trial (240 = 4 hours) */
+    trialSparks?: number;
+}
+/**
+ * Video slot configuration
+ */
+interface VideoSlot {
+    id: string;
+    name: string;
+    url: string;
+}
+/**
+ * Command handler for scene-specific commands
+ */
+type CommandHandler = (type: string, payload?: Record<string, unknown>) => void;
+/**
+ * Custom scene tab definition for Full/Custom tier
+ */
+interface SceneTabDefinition {
+    /** Tab label shown in the tab bar */
+    label: string;
+    /** Unique tab ID */
+    id: string;
+    /** React-ECS component that renders the tab content */
+    render: () => any;
+}
+/**
+ * Configuration options for AdminPanelModule
+ */
+interface AdminPanelConfig {
+    /**
+     * Scene ID for API calls
+     */
+    sceneId: string;
+    /**
+     * Panel title (shown in header)
+     */
+    title?: string;
+    /**
+     * Header background color (default: red)
+     */
+    headerColor?: {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+    /**
+     * Show Video tab (default: true for Pro tier)
+     */
+    showVideoTab?: boolean;
+    /**
+     * Show Mod tab (default: true for owners)
+     */
+    showModTab?: boolean;
+    /**
+     * Custom scene tabs (Full/Custom tier only)
+     */
+    sceneTabs?: SceneTabDefinition[];
+    /**
+     * Command handler for scene-specific commands (e.g., elevator, lights)
+     * Called when admin triggers a command from the panel
+     */
+    onCommand?: CommandHandler;
+    /**
+     * Callback when video URL should be played
+     */
+    onVideoPlay?: (url: string) => void;
+    /**
+     * Callback when video playback should stop
+     */
+    onVideoStop?: () => void;
+    /**
+     * Callback when video slot is selected
+     */
+    onVideoSlotPlay?: (slot: string) => void;
+    /**
+     * Callback for broadcast messages
+     */
+    onBroadcast?: (text: string) => void;
+    /**
+     * Link shown in footer (default: scene page on thestatic.tv)
+     */
+    footerLink?: string;
+    /**
+     * Enable debug logging
+     */
+    debug?: boolean;
+}
 
 /**
  * Guide module - fetch channel lineup from thestatic.tv
@@ -534,12 +641,106 @@ declare class ChatUIModule {
     private renderToggleButton;
 }
 
+/**
+ * Admin Panel UI Module for The Static TV SDK (Pro Tier)
+ *
+ * Provides in-scene admin controls:
+ * - Video Tab: Stream control, video playback, slots
+ * - Mod Tab: Scene admins, banned wallets, broadcast
+ * - Custom Scene Tabs: Full/Custom tier
+ */
+
+declare class AdminPanelUIModule {
+    private client;
+    private config;
+    private baseUrl;
+    private isAdmin;
+    private isOwner;
+    private panelOpen;
+    private activeTab;
+    private playerWallet;
+    private customVideoUrl;
+    private streamData;
+    private streamFetched;
+    private channelCreating;
+    private channelCreateError;
+    private channelDeleting;
+    private channelDeleteError;
+    private keyRotating;
+    private keyRotateStatus;
+    private streamControlling;
+    private streamControlStatus;
+    private pollIntervalId;
+    private trialClaiming;
+    private trialClaimError;
+    private sceneAdmins;
+    private bannedWallets;
+    private newAdminWallet;
+    private newBanWallet;
+    private broadcastText;
+    private modStatus;
+    private modsFetched;
+    constructor(client: StaticTVClient, config: AdminPanelConfig);
+    private log;
+    /**
+     * Initialize the admin panel - checks admin status
+     */
+    init(): Promise<void>;
+    /**
+     * Check if current player is an admin for this scene
+     */
+    checkAdminStatus(): Promise<void>;
+    /**
+     * Toggle the admin panel open/closed
+     */
+    toggle(): void;
+    /**
+     * Check if the panel is currently open
+     */
+    get isOpen(): boolean;
+    /**
+     * Check if current user has admin access
+     */
+    get hasAccess(): boolean;
+    /**
+     * Register a custom scene tab (Full/Custom tier)
+     */
+    registerSceneTab(tab: SceneTabDefinition): void;
+    private startStreamPolling;
+    private stopStreamPolling;
+    private fetchStreamData;
+    private refreshStreamStatus;
+    private createChannel;
+    private claimTrial;
+    private deleteChannel;
+    private startStream;
+    private stopStream;
+    private rotateStreamKey;
+    private fetchModData;
+    private addSceneAdmin;
+    private removeSceneAdmin;
+    private banWallet;
+    private unbanWallet;
+    private banKickPlayer;
+    private sendBroadcast;
+    private setActiveTab;
+    private SectionHead;
+    private TabBtn;
+    private VideoTab;
+    private ModTab;
+    /**
+     * Get the React-ECS component for the admin panel
+     */
+    getComponent: () => ReactEcs.JSX.Element | null;
+}
+
 /**
  * StaticTVClient - Main client for connecting DCL scenes to thestatic.tv
  *
  * All keys use dcls_ prefix. Features enabled based on sdkType from server:
  * - lite: Session tracking only
  * - full: Guide, Chat, Heartbeat, Interactions + session tracking
+ * - pro: Full + Admin Panel (Video + Mod tabs)
  */
 
 /** Key type constants (legacy - kept for compatibility) */
@@ -551,6 +752,7 @@ declare class StaticTVClient {
     private _keyType;
     private _disabled;
     private _fullFeaturesEnabled;
+    private _proFeaturesEnabled;
     /** Guide module - fetch channel lineup (full SDK only) */
     guide: GuideModule | null;
     /** Session module - track visitor sessions (all keys, null when disabled) */
@@ -563,6 +765,8 @@ declare class StaticTVClient {
     guideUI: GuideUIModule | null;
     /** Chat UI module - real-time chat UI (full SDK only) */
     chatUI: ChatUIModule | null;
+    /** Admin Panel module - Video/Mod tabs (pro SDK only) */
+    adminPanel: AdminPanelUIModule | null;
     /**
      * Create a new StaticTVClient
      *
@@ -570,16 +774,15 @@ declare class StaticTVClient {
      *
      * @example
      * ```typescript
-     * // Full access with channel key
-     * const staticTV = new StaticTVClient({
-     *   apiKey: 'dclk_your_channel_key_here',
-     *   debug: true
-     * });
+     * let staticTV: StaticTVClient
      *
-     * // Lite mode with scene key (visitors only)
-     * const staticTV = new StaticTVClient({
-     *   apiKey: 'dcls_your_scene_key_here'
-     * });
+     * export function main() {
+     *   // All keys use dcls_ prefix - features determined by subscription
+     *   staticTV = new StaticTVClient({
+     *     apiKey: 'dcls_your_key_here'
+     *   })
+     *   // Session tracking starts automatically!
+     * }
      * ```
      */
     constructor(config: StaticTVConfig);
@@ -626,10 +829,51 @@ declare class StaticTVClient {
      * Check if full features are enabled (server confirmed sdkType: 'full')
      */
     get hasFullFeatures(): boolean;
+    /**
+     * Check if pro features are enabled (admin panel)
+     */
+    get hasProFeatures(): boolean;
     /**
      * Get the SDK type (lite or full) - only available after session starts
      */
     get sdkType(): 'lite' | 'full';
+    /**
+     * Enable Pro features (Admin Panel with Video + Mod tabs)
+     * Call this after creating the client to add admin panel functionality.
+     *
+     * @param config Admin panel configuration
+     *
+     * @example
+     * ```typescript
+     * const staticTV = new StaticTVClient({ apiKey: 'dcls_...' })
+     *
+     * // Enable admin panel
+     * staticTV.enableProFeatures({
+     *   sceneId: 'my-scene',
+     *   title: 'MY SCENE ADMIN',
+     *   onVideoPlay: (url) => videoPlayer.play(url),
+     *   onVideoStop: () => videoPlayer.stop(),
+     *   onBroadcast: (text) => showNotification(text)
+     * })
+     * ```
+     */
+    enableProFeatures(config: AdminPanelConfig): void;
+    /**
+     * Register a custom scene tab for the admin panel (Full/Custom tier)
+     * Must call enableProFeatures() first.
+     *
+     * @param tab The tab definition with label, id, and render function
+     *
+     * @example
+     * ```typescript
+     * staticTV.registerSceneTab({
+     *   label: 'LIGHTS',
+     *   id: 'lights',
+     *   render: () => <MyLightsControls />
+     * })
+     * ```
+     */
+    registerSceneTab(tab: SceneTabDefinition): void;
     /**
      * Cleanup when done (call before scene unload)
      */
@@ -660,4 +904,4 @@ declare function getPlayerWallet(): string | null;
  */
 declare function getPlayerDisplayName(): string | null;
 
-export { type Channel, type ChatChannel, type ChatMessage, type ChatUIConfig, ChatUIModule, type GuideFeaturedPlaylist, GuideModule, type GuideResponse, type GuideUIConfig, GuideUIModule, type GuideVideo, HeartbeatModule, type HeartbeatResponse, type InteractionResponse, InteractionsModule, KEY_TYPE_CHANNEL, KEY_TYPE_SCENE, type PlayerData, type SceneStats, type SceneStatsResponse, SessionModule, type SessionResponse, StaticTVClient, type StaticTVConfig, type Vod, fetchUserData, getPlayerDisplayName, getPlayerWallet };
+export { type AdminPanelConfig, AdminPanelUIModule, type Channel, type ChatChannel, type ChatMessage, type ChatUIConfig, ChatUIModule, type CommandHandler, type GuideFeaturedPlaylist, GuideModule, type GuideResponse, type GuideUIConfig, GuideUIModule, type GuideVideo, HeartbeatModule, type HeartbeatResponse, type InteractionResponse, InteractionsModule, KEY_TYPE_CHANNEL, KEY_TYPE_SCENE, type PlayerData, type SceneStats, type SceneStatsResponse, type SceneTabDefinition, SessionModule, type SessionResponse, StaticTVClient, type StaticTVConfig, type StreamData, type VideoSlot, type Vod, fetchUserData, getPlayerDisplayName, getPlayerWallet };