@getlimelight/sdk 0.1.4 → 0.2.0

package/dist/index.d.mts

@@ -210,6 +210,82 @@ declare enum GraphqlOprtation {
     SUB = "SUBSCRIPTION"
 }
 
+/**
+ * Render lifecycle phases
+ */
+declare enum RenderPhase {
+    MOUNT = "mount",
+    UPDATE = "update",
+    UNMOUNT = "unmount"
+}
+/**
+ * What triggered this render
+ */
+declare enum RenderCauseType {
+    STATE_CHANGE = "state_change",
+    PROPS_CHANGE = "props_change",
+    CONTEXT_CHANGE = "context_change",
+    PARENT_RENDER = "parent_render",
+    FORCE_UPDATE = "force_update",
+    UNKNOWN = "unknown"
+}
+/**
+ * Component type classification
+ */
+type ComponentType = "function" | "class" | "memo" | "forwardRef" | "unknown";
+/**
+ * Transaction boundary markers (emitted by LimelightProvider)
+ */
+interface TransactionEvent {
+    phase: "TRANSACTION_START" | "TRANSACTION_END";
+    transactionId: string;
+    sessionId: string;
+    timestamp: number;
+    trigger?: string;
+}
+/**
+ * Snapshot of prop change stats sent to desktop.
+ */
+interface PropChangeSnapshot {
+    topChangedProps: {
+        key: string;
+        count: number;
+        referenceOnlyPercent: number;
+    }[];
+}
+/**
+ * Snapshot of component render stats sent to desktop.
+ */
+interface RenderSnapshot {
+    phase: "RENDER_SNAPSHOT";
+    sessionId: string;
+    timestamp: number;
+    profiles: ComponentProfileSnapshot[];
+}
+interface ComponentProfileSnapshot {
+    id: string;
+    componentId: string;
+    componentName: string;
+    componentType: ComponentType;
+    totalRenders: number;
+    totalRenderCost: number;
+    avgRenderCost: number;
+    rendersDelta: number;
+    renderCostDelta: number;
+    renderVelocity: number;
+    causeBreakdown: Record<RenderCauseType, number>;
+    causeDeltaBreakdown: Record<RenderCauseType, number>;
+    parentComponentId?: string;
+    depth: number;
+    lastTransactionId?: string;
+    isSuspicious: boolean;
+    suspiciousReason?: string;
+    renderPhase: RenderPhase;
+    mountedAt: number;
+    unmountedAt?: number;
+    propChanges?: PropChangeSnapshot;
+}
+
 /**
  * Configuration options for Limelight SDK.
  *
@@ -270,7 +346,11 @@ interface LimelightConfig {
      */
     disableBodyCapture?: boolean;
     /**
-     * A callback function to modify or filter events before they are sent to the server.
+     * Flag to enable or disable render inspection.
+     */
+    enableRenderInspector?: boolean;
+    /**
+     * A callback function to modify or filter events before they are sent to the server
      */
     beforeSend?: (event: LimelightMessage) => LimelightMessage | null;
 }
@@ -292,7 +372,7 @@ interface ConnectionEvent {
 /**
  * Union type representing all possible Limelight messages.
  */
-type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent;
+type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent | RenderSnapshot | TransactionEvent;
 
 /**
  * Represents a single frame in a stack trace.
@@ -325,10 +405,11 @@ declare class LimelightClient {
     private networkInterceptor;
     private xhrInterceptor;
     private consoleInterceptor;
+    private renderInterceptor;
     constructor();
     /**
      * Configures the Limelight client with the provided settings.
-     * Sets up network, XHR, and console interceptors based on the configuration.
+     * Sets up network, XHR, console, and render interceptors based on the configuration.
      * @internal
      * @private
      * @param {LimelightConfig} config - Configuration object for Limelight

package/dist/index.d.ts

@@ -210,6 +210,82 @@ declare enum GraphqlOprtation {
     SUB = "SUBSCRIPTION"
 }
 
+/**
+ * Render lifecycle phases
+ */
+declare enum RenderPhase {
+    MOUNT = "mount",
+    UPDATE = "update",
+    UNMOUNT = "unmount"
+}
+/**
+ * What triggered this render
+ */
+declare enum RenderCauseType {
+    STATE_CHANGE = "state_change",
+    PROPS_CHANGE = "props_change",
+    CONTEXT_CHANGE = "context_change",
+    PARENT_RENDER = "parent_render",
+    FORCE_UPDATE = "force_update",
+    UNKNOWN = "unknown"
+}
+/**
+ * Component type classification
+ */
+type ComponentType = "function" | "class" | "memo" | "forwardRef" | "unknown";
+/**
+ * Transaction boundary markers (emitted by LimelightProvider)
+ */
+interface TransactionEvent {
+    phase: "TRANSACTION_START" | "TRANSACTION_END";
+    transactionId: string;
+    sessionId: string;
+    timestamp: number;
+    trigger?: string;
+}
+/**
+ * Snapshot of prop change stats sent to desktop.
+ */
+interface PropChangeSnapshot {
+    topChangedProps: {
+        key: string;
+        count: number;
+        referenceOnlyPercent: number;
+    }[];
+}
+/**
+ * Snapshot of component render stats sent to desktop.
+ */
+interface RenderSnapshot {
+    phase: "RENDER_SNAPSHOT";
+    sessionId: string;
+    timestamp: number;
+    profiles: ComponentProfileSnapshot[];
+}
+interface ComponentProfileSnapshot {
+    id: string;
+    componentId: string;
+    componentName: string;
+    componentType: ComponentType;
+    totalRenders: number;
+    totalRenderCost: number;
+    avgRenderCost: number;
+    rendersDelta: number;
+    renderCostDelta: number;
+    renderVelocity: number;
+    causeBreakdown: Record<RenderCauseType, number>;
+    causeDeltaBreakdown: Record<RenderCauseType, number>;
+    parentComponentId?: string;
+    depth: number;
+    lastTransactionId?: string;
+    isSuspicious: boolean;
+    suspiciousReason?: string;
+    renderPhase: RenderPhase;
+    mountedAt: number;
+    unmountedAt?: number;
+    propChanges?: PropChangeSnapshot;
+}
+
 /**
  * Configuration options for Limelight SDK.
  *
@@ -270,7 +346,11 @@ interface LimelightConfig {
      */
     disableBodyCapture?: boolean;
     /**
-     * A callback function to modify or filter events before they are sent to the server.
+     * Flag to enable or disable render inspection.
+     */
+    enableRenderInspector?: boolean;
+    /**
+     * A callback function to modify or filter events before they are sent to the server
      */
     beforeSend?: (event: LimelightMessage) => LimelightMessage | null;
 }
@@ -292,7 +372,7 @@ interface ConnectionEvent {
 /**
  * Union type representing all possible Limelight messages.
  */
-type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent;
+type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent | RenderSnapshot | TransactionEvent;
 
 /**
  * Represents a single frame in a stack trace.
@@ -325,10 +405,11 @@ declare class LimelightClient {
     private networkInterceptor;
     private xhrInterceptor;
     private consoleInterceptor;
+    private renderInterceptor;
     constructor();
     /**
      * Configures the Limelight client with the provided settings.
-     * Sets up network, XHR, and console interceptors based on the configuration.
+     * Sets up network, XHR, console, and render interceptors based on the configuration.
      * @internal
      * @private
      * @param {LimelightConfig} config - Configuration object for Limelight