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

package/README.md

@@ -16,10 +16,9 @@ This SDK allows DCL scene builders to:
 
 | Tier | Price | Features |
 |------|-------|----------|
-| **Lite** | $5/mo | Session/visitor tracking, Guide button, Chat button |
-| **Full** | $10/mo | Lite + Guide UI, Chat UI, Heartbeat, Interactions |
-| **Pro** | $15/mo | Full + Admin Panel (Video tab, Mod tab) |
-| **Custom** | $20/mo | Pro + Custom scene tabs for scene-specific controls |
+| **Free** | $5/mo | Session/visitor tracking only |
+| **Standard** | $10/mo | Free + Guide UI, Chat UI, Heartbeat, Interactions |
+| **Pro** | $15/mo | Standard + Admin Panel (Video tab, Mod tab, Custom scene tabs) |
 
 > **All keys use `dcls_` prefix** - the server determines your subscription level.
 >
@@ -116,7 +115,7 @@ await staticTV.interactions.follow('channel-slug')
 await staticTV.destroy()
 ```
 
-## Lite Mode (Visitor Tracking Only)
+## Free Tier (Visitor Tracking Only)
 
 If you don't have a channel but want to track visitors to your scene:
 
@@ -139,14 +138,17 @@ export function main() {
 }
 ```
 
-3. Check if running in lite mode:
+3. Check the current tier:
 
 ```typescript
-if (staticTV.isLite) {
-  console.log('Running in lite mode - session tracking only')
+// Check tier (free, standard, or pro)
+console.log('Current tier:', staticTV.tier)
+
+if (staticTV.isFree) {
+  console.log('Running in free tier - session tracking only')
 }
 
-// guide, heartbeat, and interactions are null in lite mode
+// guide, heartbeat, and interactions are null in free tier
 if (staticTV.guide) {
   const channels = await staticTV.guide.getChannels()
 }
@@ -173,25 +175,28 @@ Main client class for interacting with thestatic.tv.
 | Property | Type | Description |
 |----------|------|-------------|
 | `keyType` | `'channel' \| 'scene'` | The detected key type |
-| `isLite` | `boolean` | `true` if using a scene key (lite mode) |
-| `hasProFeatures` | `boolean` | `true` if pro features are enabled |
-| `guide` | `GuideModule \| null` | Guide module (null in lite mode) |
+| `tier` | `'free' \| 'standard' \| 'pro'` | Current subscription tier |
+| `isFree` | `boolean` | `true` if free tier (session tracking only) |
+| `hasStandardFeatures` | `boolean` | `true` if standard features enabled |
+| `hasProFeatures` | `boolean` | `true` if pro features enabled |
+| `guide` | `GuideModule \| null` | Guide module (null in free tier) |
 | `session` | `SessionModule` | Session module (always available) |
-| `heartbeat` | `HeartbeatModule \| null` | Heartbeat module (null in lite mode) |
-| `interactions` | `InteractionsModule \| null` | Interactions module (null in lite mode) |
-| `guideUI` | `GuideUIModule \| null` | Guide UI module (null in lite mode) |
-| `chatUI` | `ChatUIModule \| null` | Chat UI module (null in lite mode) |
+| `heartbeat` | `HeartbeatModule \| null` | Heartbeat module (null in free tier) |
+| `interactions` | `InteractionsModule \| null` | Interactions module (null in free tier) |
+| `guideUI` | `GuideUIModule \| null` | Guide UI module (null in free tier) |
+| `chatUI` | `ChatUIModule \| null` | Chat UI module (null in free tier) |
 | `adminPanel` | `AdminPanelUIModule \| null` | Admin panel (null until enableProFeatures() called) |
+| `isLite` | `boolean` | **Deprecated**: Use `isFree` instead |
 
 #### Methods
 
 | Method | Description |
 |--------|-------------|
 | `enableProFeatures(config)` | Enable Pro tier admin panel |
-| `registerSceneTab(tab)` | Add custom scene tab (Custom tier) |
+| `registerSceneTab(tab)` | Add custom scene tab (Pro tier) |
 | `destroy()` | Cleanup before scene unload |
 
-### Guide Module (Full Mode Only)
+### Guide Module (Standard/Pro Tier)
 
 ```typescript
 staticTV.guide.getChannels()       // Get all channels (cached 30s)
@@ -210,9 +215,18 @@ staticTV.session.startSession()    // Manually start session
 staticTV.session.endSession()      // End session
 staticTV.session.getSessionId()    // Get current session ID
 staticTV.session.isSessionActive() // Check if session is active
+
+// Get scene stats (visitors, sessions, etc.)
+const stats = await staticTV.session.getStats()
+if (stats) {
+  console.log('Total sessions today:', stats.totalSessions)
+  console.log('Unique visitors:', stats.uniqueVisitors)
+  console.log('Total minutes watched:', stats.totalMinutes)
+  console.log('You are visitor #', stats.visitorNumber)
+}
 ```
 
-### Heartbeat Module (Full Mode Only)
+### Heartbeat Module (Standard/Pro Tier)
 
 Track video watching. Each heartbeat represents 1 minute watched.
 
@@ -223,7 +237,7 @@ staticTV.heartbeat.getCurrentChannel()          // Get currently watched channel
 staticTV.heartbeat.isCurrentlyWatching()        // Check if watching
 ```
 
-### Interactions Module (Full Mode Only)
+### Interactions Module (Standard/Pro Tier)
 
 Like and follow channels. Requires wallet connection.
 
@@ -232,7 +246,7 @@ staticTV.interactions.like(channelSlug)   // Like a channel
 staticTV.interactions.follow(channelSlug) // Follow a channel
 ```
 
-### Guide UI Module (Full Mode Only)
+### Guide UI Module (Standard/Pro Tier)
 
 Built-in channel browser UI. You provide a callback to handle video selection.
 
@@ -269,7 +283,7 @@ staticTV.guideUI.currentVideoId = 'video-id'
 await staticTV.guideUI.refresh()
 ```
 
-### Chat UI Module (Full Mode Only)
+### Chat UI Module (Standard/Pro Tier)
 
 Real-time chat with Firebase authentication.
 
@@ -325,7 +339,7 @@ export function main() {
 
   // Enable admin panel (Pro tier)
   staticTV.enableProFeatures({
-    sceneId: 'my-scene',           // Your scene ID from thestatic.tv
+    // sceneId is optional - defaults to your API key ID
     title: 'MY SCENE ADMIN',       // Panel header title
     onVideoPlay: (url) => {
       // Handle video playback in your scene
@@ -365,7 +379,7 @@ if (staticTV.adminPanel.hasAccess) { ... }
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `sceneId` | `string` | required | Scene ID for API calls |
+| `sceneId` | `string` | API key ID | Scene ID for API calls (optional - defaults to your API key ID) |
 | `title` | `string` | `'ADMIN PANEL'` | Header title |
 | `headerColor` | `{r,g,b,a}` | red | Header background color |
 | `showVideoTab` | `boolean` | `true` | Show Video tab |
@@ -378,7 +392,7 @@ if (staticTV.adminPanel.hasAccess) { ... }
 | `footerLink` | `string` | scene page | Link shown in footer |
 | `debug` | `boolean` | `false` | Enable debug logging |
 
-### Custom Scene Tabs (Custom Tier)
+### Custom Scene Tabs (Pro Tier)
 
 Add your own scene-specific control tabs to the admin panel: