@getlimelight/sdk 0.3.1 → 0.4.0

package/dist/index.d.mts

@@ -286,6 +286,70 @@ interface ComponentProfileSnapshot {
     propChanges?: PropChangeSnapshot;
 }
 
+/**
+ * Supported state management libraries
+ */
+declare enum StateLibrary {
+    ZUSTAND = "zustand",
+    REDUX = "redux"
+}
+/**
+ * State event phases
+ */
+declare enum StatePhase {
+    INIT = "STATE:INIT",
+    UPDATE = "STATE:UPDATE"
+}
+/**
+ * Action info captured during state updates
+ */
+interface StateAction {
+    /**
+     * Action type/name
+     * - Redux: action.type
+     * - Zustand: inferred from stack trace or 'set'
+     */
+    type: string;
+    /**
+     * Action payload
+     * - Redux: action.payload
+     * - Zustand: partial state passed to set()
+     */
+    payload?: unknown;
+}
+/**
+ * Base shape for state events
+ */
+interface BaseStateEvent {
+    phase: StatePhase;
+    sessionId: string;
+    timestamp: number;
+}
+/**
+ * Initial state snapshot sent when store is registered
+ */
+interface StateInitEvent extends BaseStateEvent {
+    phase: StatePhase.INIT;
+    data: {
+        storeId: string;
+        library: StateLibrary;
+        state: unknown;
+    };
+}
+/**
+ * State update event sent on every state change
+ */
+interface StateUpdateEvent extends BaseStateEvent {
+    phase: StatePhase.UPDATE;
+    data: {
+        storeId: string;
+        library: StateLibrary;
+        state: unknown;
+        action: StateAction;
+        stackTrace?: string;
+    };
+}
+
 /**
  * Configuration options for Limelight SDK.
  *
@@ -349,6 +413,20 @@ interface LimelightConfig {
      * Flag to enable or disable render inspection.
      */
     enableRenderInspector?: boolean;
+    /**
+     * Zustand store hooks or Redux stores, keyed by display name
+     * @example { user: useUserStore, cart: useCartStore }
+     */
+    stores?: Record<string, unknown>;
+    /**
+     * Flag to enable or disable state inspection
+     * @default true (if stores are provided)
+     */
+    enableStateInspector?: boolean;
+    /**
+     * Flag to enable or disable internal logging for the Limelight SDK
+     */
+    internalLoggingEnabled?: boolean;
     /**
      * A callback function to modify or filter events before they are sent to the server
      */
@@ -372,7 +450,7 @@ interface ConnectionEvent {
 /**
  * Union type representing all possible Limelight messages.
  */
-type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent | RenderSnapshot | TransactionEvent;
+type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent | RenderSnapshot | TransactionEvent | StateInitEvent | StateUpdateEvent;
 
 /**
  * Represents a single frame in a stack trace.
@@ -406,6 +484,7 @@ declare class LimelightClient {
     private xhrInterceptor;
     private consoleInterceptor;
     private renderInterceptor;
+    private stateInterceptor;
     constructor();
     /**
      * Configures the Limelight client with the provided settings.

package/dist/index.d.ts

@@ -286,6 +286,70 @@ interface ComponentProfileSnapshot {
     propChanges?: PropChangeSnapshot;
 }
 
+/**
+ * Supported state management libraries
+ */
+declare enum StateLibrary {
+    ZUSTAND = "zustand",
+    REDUX = "redux"
+}
+/**
+ * State event phases
+ */
+declare enum StatePhase {
+    INIT = "STATE:INIT",
+    UPDATE = "STATE:UPDATE"
+}
+/**
+ * Action info captured during state updates
+ */
+interface StateAction {
+    /**
+     * Action type/name
+     * - Redux: action.type
+     * - Zustand: inferred from stack trace or 'set'
+     */
+    type: string;
+    /**
+     * Action payload
+     * - Redux: action.payload
+     * - Zustand: partial state passed to set()
+     */
+    payload?: unknown;
+}
+/**
+ * Base shape for state events
+ */
+interface BaseStateEvent {
+    phase: StatePhase;
+    sessionId: string;
+    timestamp: number;
+}
+/**
+ * Initial state snapshot sent when store is registered
+ */
+interface StateInitEvent extends BaseStateEvent {
+    phase: StatePhase.INIT;
+    data: {
+        storeId: string;
+        library: StateLibrary;
+        state: unknown;
+    };
+}
+/**
+ * State update event sent on every state change
+ */
+interface StateUpdateEvent extends BaseStateEvent {
+    phase: StatePhase.UPDATE;
+    data: {
+        storeId: string;
+        library: StateLibrary;
+        state: unknown;
+        action: StateAction;
+        stackTrace?: string;
+    };
+}
+
 /**
  * Configuration options for Limelight SDK.
  *
@@ -349,6 +413,20 @@ interface LimelightConfig {
      * Flag to enable or disable render inspection.
      */
     enableRenderInspector?: boolean;
+    /**
+     * Zustand store hooks or Redux stores, keyed by display name
+     * @example { user: useUserStore, cart: useCartStore }
+     */
+    stores?: Record<string, unknown>;
+    /**
+     * Flag to enable or disable state inspection
+     * @default true (if stores are provided)
+     */
+    enableStateInspector?: boolean;
+    /**
+     * Flag to enable or disable internal logging for the Limelight SDK
+     */
+    internalLoggingEnabled?: boolean;
     /**
      * A callback function to modify or filter events before they are sent to the server
      */
@@ -372,7 +450,7 @@ interface ConnectionEvent {
 /**
  * Union type representing all possible Limelight messages.
  */
-type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent | RenderSnapshot | TransactionEvent;
+type LimelightMessage = NetworkRequest | NetworkResponse | NetworkErrorEvent | ConsoleEvent | ConnectionEvent | RenderSnapshot | TransactionEvent | StateInitEvent | StateUpdateEvent;
 
 /**
  * Represents a single frame in a stack trace.
@@ -406,6 +484,7 @@ declare class LimelightClient {
     private xhrInterceptor;
     private consoleInterceptor;
     private renderInterceptor;
+    private stateInterceptor;
     constructor();
     /**
      * Configures the Limelight client with the provided settings.