@getlimelight/sdk 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,8 +6,13 @@
6
6
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
7
7
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue)](https://www.typescriptlang.org/)
8
8
 
9
+ ## Official documentation
10
+
11
+ Read the full docs at **[docs.getlimelight.io](https://docs.getlimelight.io)**.
12
+
9
13
  ## Features
10
14
 
15
+ - 🙂 **Find why things re-render** - Get detailed information on what is causing your app to render
11
16
  - 🔍 **Network Inspection** - Capture and analyze all network requests (fetch & XMLHttpRequest)
12
17
  - 🎯 **GraphQL-First** - Automatic GraphQL operation detection, complexity analysis, and query parsing
13
18
  - 📊 **Console Streaming** - Real-time console logs with source detection and stack traces
@@ -32,16 +37,16 @@ pnpm add @getlimelight/sdk
32
37
 
33
38
  ## Quick Start
34
39
 
35
- ### Basic Usage
40
+ ### Basic Usage for the desktop app
36
41
 
37
42
  ```typescript
38
43
  import { Limelight } from "@getlimelight/sdk";
39
44
 
40
45
  // That's it! One line to start debugging
41
- Limelight.connect({ projectKey: "project-123" });
46
+ Limelight.connect();
42
47
  ```
43
48
 
44
- ### React Native
49
+ ### Provide your projectKey to use the web Limelight app
45
50
 
46
51
  ```typescript
47
52
  import { Limelight } from "@getlimelight/sdk";
@@ -49,19 +54,6 @@ import { Limelight } from "@getlimelight/sdk";
49
54
  Limelight.connect({ projectKey: "project-123" });
50
55
  ```
51
56
 
52
- ### Expo
53
-
54
- ```typescript
55
- import { Limelight } from "@getlimelight/sdk";
56
- import Constants from "expo-constants";
57
-
58
- Limelight.connect({
59
- projectKey: "project-123",
60
- enabled: __DEV__,
61
- appName: Constants.expoConfig?.name,
62
- });
63
- ```
64
-
65
57
  ## Configuration
66
58
 
67
59
  ### Configuration Options
@@ -70,8 +62,8 @@ Limelight.connect({
70
62
  import { Limelight } from '@getlimelight/sdk';
71
63
 
72
64
  Limelight.connect({
73
- // The only required field: project Id:
74
- projectKey: string;
65
+ // Required to connect to the Limelight web app. Your project key can be found in organization settings.
66
+ projectKey?: string;
75
67
 
76
68
  // Optional: Platform identifier (auto-detected)
77
69
  platform?: string;
@@ -120,7 +112,6 @@ Limelight.connect({
120
112
  import { Limelight } from "@getlimelight/sdk";
121
113
 
122
114
  Limelight.connect({
123
- projectKey: "project-123",
124
115
  serverUrl: "ws://192.168.1.100:8080", // Your computer's IP
125
116
  appName: "MyApp",
126
117
  });
package/dist/index.js CHANGED
@@ -258,7 +258,7 @@ var SENSITIVE_HEADERS = [
258
258
  var LIMELIGHT_WEB_WSS_URL = "wss://api.getlimelight.io";
259
259
  var LIMELIGHT_DESKTOP_WSS_URL = "ws://localhost:8484";
260
260
  var WS_PATH = "/limelight";
261
- var SDK_VERSION = true ? "0.3.0" : "test-version";
261
+ var SDK_VERSION = true ? "0.3.1" : "test-version";
262
262
  var RENDER_THRESHOLDS = {
263
263
  HOT_VELOCITY: 5,
264
264
  HIGH_RENDER_COUNT: 50,
package/dist/index.mjs CHANGED
@@ -222,7 +222,7 @@ var SENSITIVE_HEADERS = [
222
222
  var LIMELIGHT_WEB_WSS_URL = "wss://api.getlimelight.io";
223
223
  var LIMELIGHT_DESKTOP_WSS_URL = "ws://localhost:8484";
224
224
  var WS_PATH = "/limelight";
225
- var SDK_VERSION = true ? "0.3.0" : "test-version";
225
+ var SDK_VERSION = true ? "0.3.1" : "test-version";
226
226
  var RENDER_THRESHOLDS = {
227
227
  HOT_VELOCITY: 5,
228
228
  HIGH_RENDER_COUNT: 50,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getlimelight/sdk",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "The react native debugger that actually works",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",