@getlimelight/sdk 0.2.1 → 0.3.1

package/README.md

@@ -6,8 +6,13 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue)](https://www.typescriptlang.org/)
 
+## Official documentation
+
+Read the full docs at **[docs.getlimelight.io](https://docs.getlimelight.io)**.
+
 ## Features
 
+- 🙂 **Find why things re-render** - Get detailed information on what is causing your app to render
 - 🔍 **Network Inspection** - Capture and analyze all network requests (fetch & XMLHttpRequest)
 - 🎯 **GraphQL-First** - Automatic GraphQL operation detection, complexity analysis, and query parsing
 - 📊 **Console Streaming** - Real-time console logs with source detection and stack traces
@@ -32,16 +37,16 @@ pnpm add @getlimelight/sdk
 
 ## Quick Start
 
-### Basic Usage
+### Basic Usage for the desktop app
 
 ```typescript
 import { Limelight } from "@getlimelight/sdk";
 
 // That's it! One line to start debugging
-Limelight.connect({ projectKey: "project-123" });
+Limelight.connect();
 ```
 
-### React Native
+### Provide your projectKey to use the web Limelight app
 
 ```typescript
 import { Limelight } from "@getlimelight/sdk";
@@ -49,19 +54,6 @@ import { Limelight } from "@getlimelight/sdk";
 Limelight.connect({ projectKey: "project-123" });
 ```
 
-### Expo
-
-```typescript
-import { Limelight } from "@getlimelight/sdk";
-import Constants from "expo-constants";
-
-Limelight.connect({
-  projectKey: "project-123",
-  enabled: __DEV__,
-  appName: Constants.expoConfig?.name,
-});
-```
-
 ## Configuration
 
 ### Configuration Options
@@ -70,8 +62,8 @@ Limelight.connect({
 import { Limelight } from '@getlimelight/sdk';
 
 Limelight.connect({
-  // The only required field: project Id:
-  projectKey: string;
+  // Required to connect to the Limelight web app. Your project key can be found in organization settings.
+  projectKey?: string;
 
   // Optional: Platform identifier (auto-detected)
   platform?: string;
@@ -120,7 +112,6 @@ Limelight.connect({
 import { Limelight } from "@getlimelight/sdk";
 
 Limelight.connect({
-  projectKey: "project-123",
   serverUrl: "ws://192.168.1.100:8080", // Your computer's IP
   appName: "MyApp",
 });

package/dist/index.d.mts

@@ -312,13 +312,13 @@ interface LimelightConfig {
     /**
      * The unique project key for authenticating with the Limelight server.
      */
-    projectKey: string;
+    projectKey?: string;
     /**
      * The platform of the application (e.g., "ios", "android").
      */
     platform?: string;
     /**
-     * The URL of the Limelight server to connect to.
+     * The URL of the Limelight server to connect to. If not provided, it falls back to the local wss server url if there is no project key, or the web wss url if there is a project key.
      */
     serverUrl?: string;
     /**
@@ -427,7 +427,7 @@ declare class LimelightClient {
      * @param {LimelightConfig} [config] - Optional configuration object.
      * @returns {void}
      */
-    connect(config: LimelightConfig): void;
+    connect(config?: LimelightConfig): void;
     /**
      * Attempts to reconnect to the Limelight server using exponential backoff.
      * Will retry up to maxReconnectAttempts times with increasing delays.

package/dist/index.d.ts

@@ -312,13 +312,13 @@ interface LimelightConfig {
     /**
      * The unique project key for authenticating with the Limelight server.
      */
-    projectKey: string;
+    projectKey?: string;
     /**
      * The platform of the application (e.g., "ios", "android").
      */
     platform?: string;
     /**
-     * The URL of the Limelight server to connect to.
+     * The URL of the Limelight server to connect to. If not provided, it falls back to the local wss server url if there is no project key, or the web wss url if there is a project key.
      */
     serverUrl?: string;
     /**
@@ -427,7 +427,7 @@ declare class LimelightClient {
      * @param {LimelightConfig} [config] - Optional configuration object.
      * @returns {void}
      */
-    connect(config: LimelightConfig): void;
+    connect(config?: LimelightConfig): void;
     /**
      * Attempts to reconnect to the Limelight server using exponential backoff.
      * Will retry up to maxReconnectAttempts times with increasing delays.

package/dist/index.js

@@ -255,7 +255,10 @@ var SENSITIVE_HEADERS = [
   "x-secret",
   "bearer"
 ];
-var SDK_VERSION = true ? "0.2.1" : "test-version";
+var LIMELIGHT_WEB_WSS_URL = "wss://api.getlimelight.io";
+var LIMELIGHT_DESKTOP_WSS_URL = "ws://localhost:8484";
+var WS_PATH = "/limelight";
+var SDK_VERSION = true ? "0.3.1" : "test-version";
 var RENDER_THRESHOLDS = {
   HOT_VELOCITY: 5,
   HIGH_RENDER_COUNT: 50,
@@ -1633,18 +1636,19 @@ var LimelightClient = class {
    * @returns {void}
    */
   configure(config) {
-    const isEnabled = config.enabled ?? isDevelopment();
+    const isEnabled = config?.enabled ?? isDevelopment();
+    const configServerUrl = config?.serverUrl ? config.serverUrl : config?.projectKey ? `${LIMELIGHT_WEB_WSS_URL}${WS_PATH}` : `${LIMELIGHT_DESKTOP_WSS_URL}${WS_PATH}`;
     this.config = {
-      appName: "Limelight App",
-      serverUrl: "wss://api.getlimelight.io/limelight",
+      ...config,
+      appName: config?.appName ?? "Limelight App",
+      serverUrl: configServerUrl,
       enabled: isEnabled,
-      enableNetworkInspector: true,
-      enableConsole: true,
-      enableGraphQL: true,
-      enableRenderInspector: true,
-      ...config
+      enableNetworkInspector: config?.enableNetworkInspector ?? true,
+      enableConsole: config?.enableConsole ?? true,
+      enableGraphQL: config?.enableGraphQL ?? true,
+      enableRenderInspector: config?.enableRenderInspector ?? true
     };
-    if (!this.config.enabled) {
+    if (!this.config?.enabled) {
       return;
     }
     this.sessionId = createSessionId();
@@ -1675,13 +1679,7 @@ var LimelightClient = class {
    * @returns {void}
    */
   connect(config) {
-    if (config) {
-      this.configure(config);
-    } else if (!this.config) {
-      throw new Error(
-        "[Limelight] Limelight not configured. Please provide a configuration object when calling connect(). Project id is the only required field."
-      );
-    }
+    this.configure(config);
     if (!this.config?.enabled) {
       return;
     }
@@ -1713,7 +1711,7 @@ var LimelightClient = class {
         data: {
           appName,
           platform: platform || (typeof window !== "undefined" ? "web" : "react-native"),
-          projectKey: this.config.projectKey,
+          projectKey: this.config.projectKey || "",
           sdkVersion: SDK_VERSION
         }
       };
@@ -1755,13 +1753,7 @@ var LimelightClient = class {
     );
     this.reconnectTimer = setTimeout(() => {
       this.reconnectTimer = null;
-      if (this.config) {
-        this.configure(this.config);
-      } else if (!this.config) {
-        throw new Error(
-          "[Limelight] Limelight not configured. Please provide a configuration object when calling connect(). Project id is the only required field."
-        );
-      }
+      this.connect(this.config || void 0);
     }, delay);
   }
   /**