Skip to content

Commit 56d36a1

Browse files
committed
refactor: rename DebuggerOverlay back to NetworkLoggerOverlay for backward compatibility
- Renamed component from DebuggerOverlay to NetworkLoggerOverlay - Renamed interface from DebuggerOverlayProps to NetworkLoggerOverlayProps - Renamed error class from DebuggerSetupError to NetworkLoggerSetupError - Updated README to reflect component name change - Updated example app import
1 parent 8b77b93 commit 56d36a1

4 files changed

Lines changed: 26 additions & 26 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,15 +109,15 @@ export default function App() {
109109

110110
### 2. Full Setup (HTTP + WebSocket)
111111

112-
Use `DebuggerOverlay` with `enableWebSocket={true}` for the unified tabbed interface.
112+
Use `NetworkLoggerOverlay` with `enableWebSocket={true}` for the unified tabbed interface.
113113

114114
```tsx
115115
import React, { useEffect } from 'react';
116116
import { View } from 'react-native';
117117
import {
118118
networkLogger,
119119
webSocketLogger,
120-
DebuggerOverlay
120+
NetworkLoggerOverlay
121121
} from 'react-native-api-debugger';
122122

123123
export default function App() {
@@ -133,7 +133,7 @@ export default function App() {
133133
<View style={{ flex: 1 }}>
134134
{/* Your app content */}
135135

136-
<DebuggerOverlay
136+
<NetworkLoggerOverlay
137137
networkLogger={networkLogger}
138138
webSocketLogger={webSocketLogger}
139139
enableWebSocket={true}
@@ -153,7 +153,7 @@ import { GestureHandlerRootView } from 'react-native-gesture-handler';
153153
import {
154154
networkLogger,
155155
webSocketLogger,
156-
DebuggerOverlay
156+
NetworkLoggerOverlay
157157
} from 'react-native-api-debugger';
158158

159159
export default function App() {
@@ -166,7 +166,7 @@ export default function App() {
166166
<GestureHandlerRootView style={{ flex: 1 }}>
167167
{/* Your app content */}
168168

169-
<DebuggerOverlay
169+
<NetworkLoggerOverlay
170170
networkLogger={networkLogger}
171171
webSocketLogger={webSocketLogger}
172172
enableWebSocket={true}
@@ -180,7 +180,7 @@ export default function App() {
180180
### 4. Full Featured Setup
181181

182182
```tsx
183-
<DebuggerOverlay
183+
<NetworkLoggerOverlay
184184
networkLogger={networkLogger}
185185
webSocketLogger={webSocketLogger}
186186
enableWebSocket={true}
@@ -385,7 +385,7 @@ webSocketLogger.restoreInterceptor();
385385

386386
## API Reference
387387

388-
### DebuggerOverlay Props
388+
### NetworkLoggerOverlay Props
389389

390390
The unified overlay component with HTTP and optional WebSocket tabs.
391391

@@ -543,11 +543,11 @@ useEffect(() => {
543543

544544
Ensure you have:
545545
1. Called `webSocketLogger.setupInterceptor()` before any WebSocket connections
546-
2. Set `enableWebSocket={true}` on the DebuggerOverlay
546+
2. Set `enableWebSocket={true}` on the NetworkLoggerOverlay
547547
3. Passed the `webSocketLogger` prop
548548

549549
```tsx
550-
<DebuggerOverlay
550+
<NetworkLoggerOverlay
551551
networkLogger={networkLogger}
552552
webSocketLogger={webSocketLogger}
553553
enableWebSocket={true} // Required to show WebSocket tab

example/src/App.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React, { useEffect, useState } from 'react';
22
import { StyleSheet, SafeAreaView, View } from 'react-native';
33
import {
4-
DebuggerOverlay,
4+
NetworkLoggerOverlay,
55
networkLogger,
66
webSocketLogger,
77
} from 'react-native-api-debugger';
@@ -54,7 +54,7 @@ const App: React.FC = () => {
5454
activeTab={activeTab}
5555
onTabPress={setActiveTab}
5656
/>
57-
<DebuggerOverlay
57+
<NetworkLoggerOverlay
5858
draggable={true}
5959
enableDeviceShake={false}
6060
useCopyToClipboard={true}

src/features/http/DebuggerOverlay.tsx renamed to src/features/http/NetworkLoggerOverlay.tsx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ try {
5252

5353
type ActiveTab = 'http' | 'websocket';
5454

55-
interface DebuggerOverlayProps {
55+
interface NetworkLoggerOverlayProps {
5656
networkLogger: NetworkLogger;
5757
webSocketLogger?: IWebSocketLogger;
5858
enabled?: boolean;
@@ -66,10 +66,10 @@ interface DebuggerOverlayProps {
6666
onThemeChange?: (theme: ThemeMode) => void;
6767
}
6868

69-
class DebuggerSetupError extends Error {
69+
class NetworkLoggerSetupError extends Error {
7070
constructor(message: string) {
7171
super(message);
72-
this.name = 'DebuggerSetupError';
72+
this.name = 'NetworkLoggerSetupError';
7373
}
7474
}
7575

@@ -81,7 +81,7 @@ const STATUS_FILTERS: { key: StatusFilterKey; label: string }[] = [
8181
{ key: 'serverError', label: '5xx' },
8282
];
8383

84-
export const DebuggerOverlay: React.FC<DebuggerOverlayProps> = ({
84+
export const NetworkLoggerOverlay: React.FC<NetworkLoggerOverlayProps> = ({
8585
draggable,
8686
networkLogger,
8787
webSocketLogger,
@@ -123,7 +123,7 @@ export const DebuggerOverlay: React.FC<DebuggerOverlayProps> = ({
123123
useEffect(() => {
124124
if (enabled && !__DEV__) {
125125
console.warn(
126-
'[DebuggerOverlay] Warning: Debugger is enabled in production mode. ' +
126+
'[NetworkLoggerOverlay] Warning: Debugger is enabled in production mode. ' +
127127
'This may expose sensitive data. Set enabled={false} or remove the prop to disable in production.'
128128
);
129129
}
@@ -134,8 +134,8 @@ export const DebuggerOverlay: React.FC<DebuggerOverlayProps> = ({
134134

135135
// Validate HTTP interceptor setup
136136
if (!networkLogger.isSetup()) {
137-
throw new DebuggerSetupError(
138-
'[DebuggerOverlay] HTTP interceptor not initialized.\n\n' +
137+
throw new NetworkLoggerSetupError(
138+
'[NetworkLoggerOverlay] HTTP interceptor not initialized.\n\n' +
139139
'Please call networkLogger.setupInterceptor() before rendering DebuggerOverlay.\n\n' +
140140
'Example:\n' +
141141
' useEffect(() => {\n' +
@@ -148,8 +148,8 @@ export const DebuggerOverlay: React.FC<DebuggerOverlayProps> = ({
148148
// Validate WebSocket interceptor setup if enabled
149149
if (enableWebSocket) {
150150
if (!webSocketLogger) {
151-
throw new DebuggerSetupError(
152-
'[DebuggerOverlay] WebSocket debugging is enabled but webSocketLogger prop is missing.\n\n' +
151+
throw new NetworkLoggerSetupError(
152+
'[NetworkLoggerOverlay] WebSocket debugging is enabled but webSocketLogger prop is missing.\n\n' +
153153
'Please pass the webSocketLogger prop when enableWebSocket={true}.\n\n' +
154154
'Example:\n' +
155155
' import { webSocketLogger, DebuggerOverlay } from "react-native-api-debugger";\n\n' +
@@ -162,8 +162,8 @@ export const DebuggerOverlay: React.FC<DebuggerOverlayProps> = ({
162162
}
163163

164164
if (!webSocketLogger.isSetup()) {
165-
throw new DebuggerSetupError(
166-
'[DebuggerOverlay] WebSocket interceptor not initialized.\n\n' +
165+
throw new NetworkLoggerSetupError(
166+
'[NetworkLoggerOverlay] WebSocket interceptor not initialized.\n\n' +
167167
'Please call webSocketLogger.setupInterceptor() before rendering DebuggerOverlay with enableWebSocket={true}.\n\n' +
168168
'Example:\n' +
169169
' useEffect(() => {\n' +
@@ -181,8 +181,8 @@ export const DebuggerOverlay: React.FC<DebuggerOverlayProps> = ({
181181
: undefined;
182182

183183
if (enableDeviceShake && !RNShake) {
184-
throw new DebuggerSetupError(
185-
'[DebuggerOverlay] react-native-shake is required for enableDeviceShake but module is not installed.\n\n' +
184+
throw new NetworkLoggerSetupError(
185+
'[NetworkLoggerOverlay] react-native-shake is required for enableDeviceShake but module is not installed.\n\n' +
186186
'Please install it with:\n' +
187187
' npm install react-native-shake\n\n' +
188188
'Or disable device shake:\n' +
@@ -957,4 +957,4 @@ const staticStyles = {
957957
} as ViewStyle,
958958
};
959959

960-
export type { DebuggerOverlayProps };
960+
export type { NetworkLoggerOverlayProps };

src/features/http/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
export * from './DebuggerOverlay';
1+
export * from './NetworkLoggerOverlay';
22
export { default as NetworkLogItem } from './NetworkLogItem';
33
export type { NetworkLogItemProps } from './NetworkLogItem';

0 commit comments

Comments
 (0)