@thestatic-tv/dcl-sdk 1.0.1 → 1.0.3

package/dist/index.d.mts

@@ -84,6 +84,26 @@ interface InteractionResponse {
     alreadyExists: boolean;
     version: string;
 }
+/**
+ * Scene stats for display in-world
+ */
+interface SceneStats {
+    date: string;
+    totalSessions: number;
+    uniqueVisitors: number;
+    totalMinutes: number;
+    visitorNumber: number | null;
+    isFirstVisitor: boolean;
+}
+/**
+ * Scene stats response from the API
+ */
+interface SceneStatsResponse {
+    success: boolean;
+    stats: SceneStats;
+    sceneName: string | null;
+    version: string;
+}
 
 /**
  * Guide module - fetch channel lineup from thestatic.tv
@@ -128,7 +148,7 @@ declare class GuideModule {
 declare class SessionModule {
     private client;
     private sessionId;
-    private heartbeatInterval;
+    private heartbeatTimerId;
     private isActive;
     constructor(client: StaticTVClient);
     /**
@@ -141,7 +161,7 @@ declare class SessionModule {
      */
     startSession(metadata?: Record<string, unknown>): Promise<string | null>;
     /**
-     * Start the heartbeat interval
+     * Start the heartbeat interval using DCL-compatible timer
      */
     private startHeartbeat;
     /**
@@ -160,6 +180,11 @@ declare class SessionModule {
      * Check if a session is currently active
      */
     isSessionActive(): boolean;
+    /**
+     * Get scene stats (visitors, sessions, etc.)
+     * Useful for displaying metrics in-world
+     */
+    getStats(): Promise<SceneStatsResponse['stats'] | null>;
 }
 
 /**
@@ -168,7 +193,7 @@ declare class SessionModule {
 
 declare class HeartbeatModule {
     private client;
-    private watchInterval;
+    private watchTimerId;
     private currentChannel;
     private isWatching;
     constructor(client: StaticTVClient);
@@ -294,4 +319,4 @@ declare class StaticTVClient {
     destroy(): Promise<void>;
 }
 
-export { type Channel, GuideModule, type GuideResponse, HeartbeatModule, type HeartbeatResponse, type InteractionResponse, InteractionsModule, KEY_TYPE_CHANNEL, KEY_TYPE_SCENE, SessionModule, type SessionResponse, StaticTVClient, type StaticTVConfig, type Vod };
+export { type Channel, GuideModule, type GuideResponse, HeartbeatModule, type HeartbeatResponse, type InteractionResponse, InteractionsModule, KEY_TYPE_CHANNEL, KEY_TYPE_SCENE, type SceneStats, type SceneStatsResponse, SessionModule, type SessionResponse, StaticTVClient, type StaticTVConfig, type Vod };

package/dist/index.d.ts

@@ -84,6 +84,26 @@ interface InteractionResponse {
     alreadyExists: boolean;
     version: string;
 }
+/**
+ * Scene stats for display in-world
+ */
+interface SceneStats {
+    date: string;
+    totalSessions: number;
+    uniqueVisitors: number;
+    totalMinutes: number;
+    visitorNumber: number | null;
+    isFirstVisitor: boolean;
+}
+/**
+ * Scene stats response from the API
+ */
+interface SceneStatsResponse {
+    success: boolean;
+    stats: SceneStats;
+    sceneName: string | null;
+    version: string;
+}
 
 /**
  * Guide module - fetch channel lineup from thestatic.tv
@@ -128,7 +148,7 @@ declare class GuideModule {
 declare class SessionModule {
     private client;
     private sessionId;
-    private heartbeatInterval;
+    private heartbeatTimerId;
     private isActive;
     constructor(client: StaticTVClient);
     /**
@@ -141,7 +161,7 @@ declare class SessionModule {
      */
     startSession(metadata?: Record<string, unknown>): Promise<string | null>;
     /**
-     * Start the heartbeat interval
+     * Start the heartbeat interval using DCL-compatible timer
      */
     private startHeartbeat;
     /**
@@ -160,6 +180,11 @@ declare class SessionModule {
      * Check if a session is currently active
      */
     isSessionActive(): boolean;
+    /**
+     * Get scene stats (visitors, sessions, etc.)
+     * Useful for displaying metrics in-world
+     */
+    getStats(): Promise<SceneStatsResponse['stats'] | null>;
 }
 
 /**
@@ -168,7 +193,7 @@ declare class SessionModule {
 
 declare class HeartbeatModule {
     private client;
-    private watchInterval;
+    private watchTimerId;
     private currentChannel;
     private isWatching;
     constructor(client: StaticTVClient);
@@ -294,4 +319,4 @@ declare class StaticTVClient {
     destroy(): Promise<void>;
 }
 
-export { type Channel, GuideModule, type GuideResponse, HeartbeatModule, type HeartbeatResponse, type InteractionResponse, InteractionsModule, KEY_TYPE_CHANNEL, KEY_TYPE_SCENE, SessionModule, type SessionResponse, StaticTVClient, type StaticTVConfig, type Vod };
+export { type Channel, GuideModule, type GuideResponse, HeartbeatModule, type HeartbeatResponse, type InteractionResponse, InteractionsModule, KEY_TYPE_CHANNEL, KEY_TYPE_SCENE, type SceneStats, type SceneStatsResponse, SessionModule, type SessionResponse, StaticTVClient, type StaticTVConfig, type Vod };

package/dist/index.js

@@ -99,7 +99,7 @@ var GuideModule = class {
 // src/utils/identity.ts
 function getPlayerWallet() {
   try {
-    const { getPlayer } = require("@dcl/sdk/src/players");
+    const { getPlayer } = require("@dcl/sdk/players");
     const player = getPlayer();
     return player?.userId ?? null;
   } catch {
@@ -108,7 +108,7 @@ function getPlayerWallet() {
 }
 function getPlayerDisplayName() {
   try {
-    const { getPlayer } = require("@dcl/sdk/src/players");
+    const { getPlayer } = require("@dcl/sdk/players");
     const player = getPlayer();
     return player?.name ?? null;
   } catch {
@@ -116,11 +116,54 @@ function getPlayerDisplayName() {
   }
 }
 
+// src/utils/timer.ts
+var import_ecs = require("@dcl/sdk/ecs");
+var nextTimerId = 1;
+var timers = /* @__PURE__ */ new Map();
+var systemAdded = false;
+function ensureTimerSystem() {
+  if (systemAdded) return;
+  import_ecs.engine.addSystem((dt) => {
+    for (const timer of timers.values()) {
+      if (!timer.active) continue;
+      timer.elapsedTime += dt;
+      if (timer.elapsedTime >= timer.intervalSeconds) {
+        timer.elapsedTime = 0;
+        try {
+          timer.callback();
+        } catch (e) {
+          console.error("[StaticTV Timer] Callback error:", e);
+        }
+      }
+    }
+  });
+  systemAdded = true;
+}
+function dclSetInterval(callback, intervalMs) {
+  ensureTimerSystem();
+  const id = nextTimerId++;
+  timers.set(id, {
+    id,
+    callback,
+    intervalSeconds: intervalMs / 1e3,
+    elapsedTime: 0,
+    active: true
+  });
+  return id;
+}
+function dclClearInterval(timerId) {
+  const timer = timers.get(timerId);
+  if (timer) {
+    timer.active = false;
+    timers.delete(timerId);
+  }
+}
+
 // src/modules/session.ts
 var SessionModule = class {
   constructor(client) {
     this.sessionId = null;
-    this.heartbeatInterval = null;
+    this.heartbeatTimerId = null;
     this.isActive = false;
     this.client = client;
   }
@@ -163,12 +206,12 @@ var SessionModule = class {
     }
   }
   /**
-   * Start the heartbeat interval
+   * Start the heartbeat interval using DCL-compatible timer
    */
   startHeartbeat() {
-    if (this.heartbeatInterval) return;
+    if (this.heartbeatTimerId !== null) return;
     const interval = this.client.getConfig().sessionHeartbeatInterval || 3e4;
-    this.heartbeatInterval = setInterval(() => {
+    this.heartbeatTimerId = dclSetInterval(() => {
       this.sendHeartbeat();
     }, interval);
   }
@@ -195,9 +238,9 @@ var SessionModule = class {
    */
   async endSession() {
     if (!this.isActive) return;
-    if (this.heartbeatInterval) {
-      clearInterval(this.heartbeatInterval);
-      this.heartbeatInterval = null;
+    if (this.heartbeatTimerId !== null) {
+      dclClearInterval(this.heartbeatTimerId);
+      this.heartbeatTimerId = null;
     }
     if (this.sessionId) {
       try {
@@ -228,12 +271,34 @@ var SessionModule = class {
   isSessionActive() {
     return this.isActive;
   }
+  /**
+   * Get scene stats (visitors, sessions, etc.)
+   * Useful for displaying metrics in-world
+   */
+  async getStats() {
+    try {
+      const wallet = getPlayerWallet();
+      const queryParam = wallet ? `?wallet=${wallet}` : "";
+      const response = await this.client.request(
+        `/scene-stats${queryParam}`,
+        { method: "GET" }
+      );
+      if (response.success && response.stats) {
+        this.client.log("Stats fetched:", response.stats);
+        return response.stats;
+      }
+      return null;
+    } catch (error) {
+      this.client.log(`Failed to fetch stats: ${error}`);
+      return null;
+    }
+  }
 };
 
 // src/modules/heartbeat.ts
 var HeartbeatModule = class {
   constructor(client) {
-    this.watchInterval = null;
+    this.watchTimerId = null;
     this.currentChannel = null;
     this.isWatching = false;
     this.client = client;
@@ -256,7 +321,7 @@ var HeartbeatModule = class {
     this.isWatching = true;
     this.sendHeartbeat();
     const interval = this.client.getConfig().watchHeartbeatInterval || 6e4;
-    this.watchInterval = setInterval(() => {
+    this.watchTimerId = dclSetInterval(() => {
       this.sendHeartbeat();
     }, interval);
     this.client.log(`Started watching ${channelSlug}`);
@@ -266,9 +331,9 @@ var HeartbeatModule = class {
    */
   stopWatching() {
     if (!this.isWatching) return;
-    if (this.watchInterval) {
-      clearInterval(this.watchInterval);
-      this.watchInterval = null;
+    if (this.watchTimerId !== null) {
+      dclClearInterval(this.watchTimerId);
+      this.watchTimerId = null;
     }
     this.client.log(`Stopped watching ${this.currentChannel}`);
     this.currentChannel = null;

package/dist/index.mjs

@@ -74,7 +74,7 @@ var GuideModule = class {
 // src/utils/identity.ts
 function getPlayerWallet() {
   try {
-    const { getPlayer } = __require("@dcl/sdk/src/players");
+    const { getPlayer } = __require("@dcl/sdk/players");
     const player = getPlayer();
     return player?.userId ?? null;
   } catch {
@@ -83,7 +83,7 @@ function getPlayerWallet() {
 }
 function getPlayerDisplayName() {
   try {
-    const { getPlayer } = __require("@dcl/sdk/src/players");
+    const { getPlayer } = __require("@dcl/sdk/players");
     const player = getPlayer();
     return player?.name ?? null;
   } catch {
@@ -91,11 +91,54 @@ function getPlayerDisplayName() {
   }
 }
 
+// src/utils/timer.ts
+import { engine } from "@dcl/sdk/ecs";
+var nextTimerId = 1;
+var timers = /* @__PURE__ */ new Map();
+var systemAdded = false;
+function ensureTimerSystem() {
+  if (systemAdded) return;
+  engine.addSystem((dt) => {
+    for (const timer of timers.values()) {
+      if (!timer.active) continue;
+      timer.elapsedTime += dt;
+      if (timer.elapsedTime >= timer.intervalSeconds) {
+        timer.elapsedTime = 0;
+        try {
+          timer.callback();
+        } catch (e) {
+          console.error("[StaticTV Timer] Callback error:", e);
+        }
+      }
+    }
+  });
+  systemAdded = true;
+}
+function dclSetInterval(callback, intervalMs) {
+  ensureTimerSystem();
+  const id = nextTimerId++;
+  timers.set(id, {
+    id,
+    callback,
+    intervalSeconds: intervalMs / 1e3,
+    elapsedTime: 0,
+    active: true
+  });
+  return id;
+}
+function dclClearInterval(timerId) {
+  const timer = timers.get(timerId);
+  if (timer) {
+    timer.active = false;
+    timers.delete(timerId);
+  }
+}
+
 // src/modules/session.ts
 var SessionModule = class {
   constructor(client) {
     this.sessionId = null;
-    this.heartbeatInterval = null;
+    this.heartbeatTimerId = null;
     this.isActive = false;
     this.client = client;
   }
@@ -138,12 +181,12 @@ var SessionModule = class {
     }
   }
   /**
-   * Start the heartbeat interval
+   * Start the heartbeat interval using DCL-compatible timer
    */
   startHeartbeat() {
-    if (this.heartbeatInterval) return;
+    if (this.heartbeatTimerId !== null) return;
     const interval = this.client.getConfig().sessionHeartbeatInterval || 3e4;
-    this.heartbeatInterval = setInterval(() => {
+    this.heartbeatTimerId = dclSetInterval(() => {
       this.sendHeartbeat();
     }, interval);
   }
@@ -170,9 +213,9 @@ var SessionModule = class {
    */
   async endSession() {
     if (!this.isActive) return;
-    if (this.heartbeatInterval) {
-      clearInterval(this.heartbeatInterval);
-      this.heartbeatInterval = null;
+    if (this.heartbeatTimerId !== null) {
+      dclClearInterval(this.heartbeatTimerId);
+      this.heartbeatTimerId = null;
     }
     if (this.sessionId) {
       try {
@@ -203,12 +246,34 @@ var SessionModule = class {
   isSessionActive() {
     return this.isActive;
   }
+  /**
+   * Get scene stats (visitors, sessions, etc.)
+   * Useful for displaying metrics in-world
+   */
+  async getStats() {
+    try {
+      const wallet = getPlayerWallet();
+      const queryParam = wallet ? `?wallet=${wallet}` : "";
+      const response = await this.client.request(
+        `/scene-stats${queryParam}`,
+        { method: "GET" }
+      );
+      if (response.success && response.stats) {
+        this.client.log("Stats fetched:", response.stats);
+        return response.stats;
+      }
+      return null;
+    } catch (error) {
+      this.client.log(`Failed to fetch stats: ${error}`);
+      return null;
+    }
+  }
 };
 
 // src/modules/heartbeat.ts
 var HeartbeatModule = class {
   constructor(client) {
-    this.watchInterval = null;
+    this.watchTimerId = null;
     this.currentChannel = null;
     this.isWatching = false;
     this.client = client;
@@ -231,7 +296,7 @@ var HeartbeatModule = class {
     this.isWatching = true;
     this.sendHeartbeat();
     const interval = this.client.getConfig().watchHeartbeatInterval || 6e4;
-    this.watchInterval = setInterval(() => {
+    this.watchTimerId = dclSetInterval(() => {
       this.sendHeartbeat();
     }, interval);
     this.client.log(`Started watching ${channelSlug}`);
@@ -241,9 +306,9 @@ var HeartbeatModule = class {
    */
   stopWatching() {
     if (!this.isWatching) return;
-    if (this.watchInterval) {
-      clearInterval(this.watchInterval);
-      this.watchInterval = null;
+    if (this.watchTimerId !== null) {
+      dclClearInterval(this.watchTimerId);
+      this.watchTimerId = null;
     }
     this.client.log(`Stopped watching ${this.currentChannel}`);
     this.currentChannel = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thestatic-tv/dcl-sdk",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Connect your Decentraland scene to thestatic.tv - full channel lineup, metrics tracking, and interactions",
   "main": "dist/index.js",
   "module": "dist/index.mjs",