@getlimelight/sdk 0.7.10 → 0.7.12

package/README.md

@@ -137,6 +137,25 @@ Client (fetch) → Your Server (middleware) → Downstream Service (http interce
 
 No additional setup is required — just connect the SDK and add the middleware.
 
+## Telemetry
+
+The SDK collects **anonymous** usage telemetry to help us understand adoption and improve the product. **No runtime data, user code, network request bodies, state values, or anything from your app is ever sent.** Only:
+
+- Framework type (react, react-native, next, node)
+- SDK version
+- Event counts and session durations
+- A random anonymous device ID (not tied to any user identity)
+
+Telemetry is **enabled by default**. To opt out:
+
+```typescript
+Limelight.connect({
+  telemetry: false,
+});
+```
+
+When `telemetry` is `false`, no events are sent and no anonymous ID is generated or stored.
+
 ## Learn More
 
 - [Quick Start Guide](https://docs.getlimelight.io/quickstart)

package/dist/index.d.mts

@@ -461,6 +461,12 @@ interface LimelightConfig {
      * Limelight.connect({ webSocketImpl: WebSocket });
      */
     webSocketImpl?: new (url: string, protocols?: string | string[]) => WebSocket;
+    /**
+     * Enable anonymous usage telemetry. Only sends event counts, durations,
+     * and framework type — never any runtime data, user code, or request content.
+     * @default true
+     */
+    telemetry?: boolean;
 }
 /**
  * Represents a connection or disconnection event in the Limelight SDK.
@@ -571,6 +577,8 @@ declare class LimelightClient {
     private reconnectTimer;
     private messageQueue;
     private maxQueueSize;
+    private sessionStartTime;
+    private sessionEventCount;
     private networkInterceptor;
     private xhrInterceptor;
     private httpInterceptor;

package/dist/index.d.ts

@@ -461,6 +461,12 @@ interface LimelightConfig {
      * Limelight.connect({ webSocketImpl: WebSocket });
      */
     webSocketImpl?: new (url: string, protocols?: string | string[]) => WebSocket;
+    /**
+     * Enable anonymous usage telemetry. Only sends event counts, durations,
+     * and framework type — never any runtime data, user code, or request content.
+     * @default true
+     */
+    telemetry?: boolean;
 }
 /**
  * Represents a connection or disconnection event in the Limelight SDK.
@@ -571,6 +577,8 @@ declare class LimelightClient {
     private reconnectTimer;
     private messageQueue;
     private maxQueueSize;
+    private sessionStartTime;
+    private sessionEventCount;
     private networkInterceptor;
     private xhrInterceptor;
     private httpInterceptor;

package/dist/index.js

@@ -292,7 +292,7 @@ var LIMELIGHT_WEB_WSS_URL = "wss://api.getlimelight.io";
 var LIMELIGHT_DESKTOP_WSS_URL = "ws://localhost:8484";
 var LIMELIGHT_MCP_WS_URL = "ws://localhost:9229";
 var WS_PATH = "/limelight";
-var SDK_VERSION = true ? "0.7.10" : "test-version";
+var SDK_VERSION = true ? "0.7.12" : "test-version";
 var RENDER_THRESHOLDS = {
   HOT_VELOCITY: 5,
   HIGH_RENDER_COUNT: 50,
@@ -316,6 +316,9 @@ var BINARY_CONTENT_TYPES = [
   "application/gzip"
 ];
 var MAX_BODY_SIZE = 1024 * 1024;
+var POSTHOG_API_KEY = true ? "phc_I4dF0Du3McRPRCdSiJfvTBMWrbsapXoTP83uaHTA1ry" : "";
+var POSTHOG_HOST = true ? "https://us.i.posthog.com" : "";
+var STORAGE_KEY = "limelight_anon_id";
 
 // src/helpers/safety/redactSensitiveHeaders.ts
 var redactSensitiveHeaders = (headers) => {
@@ -2947,6 +2950,119 @@ var createWithLimelight = (sendMessage, getSessionId, getConfig, options) => {
   };
 };
 
+// src/limelight/telemetry.ts
+var anonymousId = null;
+var enabled = false;
+var framework = "unknown";
+var detectFramework = () => {
+  try {
+    if (typeof navigator !== "undefined" && "ReactNative" in navigator)
+      return "react-native";
+    if (typeof process !== "undefined" && (process.env?.__NEXT_RUNTIME__ || process.env?.NEXT_RUNTIME))
+      return "next";
+    if (typeof window !== "undefined" && window.__NEXT_DATA__)
+      return "next";
+    if (hasDOM()) return "react";
+    if (isServer()) return "node";
+  } catch {
+  }
+  return "unknown";
+};
+var generateId = () => {
+  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
+    const r = Math.random() * 16 | 0;
+    return (c === "x" ? r : r & 3 | 8).toString(16);
+  });
+};
+var getOrCreateAnonymousId = () => {
+  if (anonymousId) return anonymousId;
+  try {
+    if (typeof localStorage !== "undefined") {
+      const stored = localStorage.getItem(STORAGE_KEY);
+      if (stored) {
+        anonymousId = stored;
+        return anonymousId;
+      }
+      anonymousId = generateId();
+      localStorage.setItem(STORAGE_KEY, anonymousId);
+      return anonymousId;
+    }
+  } catch {
+  }
+  try {
+    const _require = globalThis["require"];
+    if (_require) {
+      const fs = _require("fs");
+      const os = _require("os");
+      const path = _require("path");
+      const filePath = path.join(os.homedir(), ".limelight_telemetry_id");
+      try {
+        anonymousId = fs.readFileSync(filePath, "utf-8").trim();
+        if (anonymousId) return anonymousId;
+      } catch {
+      }
+      anonymousId = generateId();
+      fs.writeFileSync(filePath, anonymousId, "utf-8");
+      return anonymousId;
+    }
+  } catch {
+  }
+  anonymousId = generateId();
+  return anonymousId;
+};
+var capture = (event, properties = {}) => {
+  if (!enabled) return;
+  try {
+    const payload = {
+      api_key: POSTHOG_API_KEY,
+      event,
+      distinct_id: getOrCreateAnonymousId(),
+      properties: {
+        ...properties,
+        sdk_version: SDK_VERSION,
+        framework
+      }
+    };
+    fetch(`${POSTHOG_HOST}/capture/`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(payload)
+    }).catch(() => {
+    });
+  } catch {
+  }
+};
+var telemetry = {
+  init(telemetryEnabled) {
+    enabled = telemetryEnabled;
+    if (!enabled) return;
+    framework = detectFramework();
+    capture("sdk_initialized", {
+      framework,
+      device_id: getOrCreateAnonymousId()
+    });
+  },
+  sessionStarted() {
+    capture("sdk_session_started");
+  },
+  sessionEnded(durationSeconds, eventCount) {
+    capture("sdk_session_ended", {
+      duration_seconds: durationSeconds,
+      event_count: eventCount
+    });
+  },
+  timelineGenerated(eventsCorrelated) {
+    capture("sdk_timeline_generated", {
+      events_correlated: eventsCorrelated,
+      framework
+    });
+  },
+  shutdown() {
+    enabled = false;
+    anonymousId = null;
+  }
+};
+
 // src/limelight/LimelightClient.ts
 var LimelightClient = class {
   ws = null;
@@ -2958,6 +3074,8 @@ var LimelightClient = class {
   reconnectTimer = null;
   messageQueue = [];
   maxQueueSize = 100;
+  sessionStartTime = 0;
+  sessionEventCount = 0;
   networkInterceptor;
   xhrInterceptor;
   httpInterceptor;
@@ -3061,6 +3179,7 @@ var LimelightClient = class {
         console.error("[Limelight] Failed to setup interceptors:", error);
       }
     }
+    telemetry.init(this.config.telemetry ?? true);
   }
   /**
    * Establishes a WebSocket connection to the Limelight server.
@@ -3125,8 +3244,11 @@ var LimelightClient = class {
       };
       this.ws.onopen = () => {
         this.reconnectAttempts = 0;
+        this.sessionStartTime = Date.now();
+        this.sessionEventCount = 0;
         this.flushMessageQueue();
         this.sendMessage(message);
+        telemetry.sessionStarted();
       };
       this.ws.onmessage = (event) => {
         try {
@@ -3209,6 +3331,12 @@ var LimelightClient = class {
    * @returns {void}
    */
   sendMessage(message) {
+    this.sessionEventCount++;
+    if ("phase" in message && message.phase === "RENDER_SNAPSHOT" && "profiles" in message) {
+      telemetry.timelineGenerated(
+        message.profiles?.length ?? 0
+      );
+    }
     if (this.ws?.readyState === 1) {
       this.flushMessageQueue();
       if (this.ws?.readyState === 1) {
@@ -3274,7 +3402,15 @@ var LimelightClient = class {
     this.renderInterceptor.cleanup();
     this.stateInterceptor.cleanup();
     this.requestBridge.cleanup();
+    if (this.sessionStartTime > 0) {
+      const durationSeconds = Math.round(
+        (Date.now() - this.sessionStartTime) / 1e3
+      );
+      telemetry.sessionEnded(durationSeconds, this.sessionEventCount);
+    }
     this.reconnectAttempts = 0;
+    this.sessionStartTime = 0;
+    this.sessionEventCount = 0;
     this.messageQueue = [];
   }
   /**
@@ -3285,6 +3421,7 @@ var LimelightClient = class {
    */
   reset() {
     this.disconnect();
+    telemetry.shutdown();
     this.config = null;
     this.sessionId = "";
   }