react-native-debug-toolkit 3.1.2 → 3.1.4

package/src/features/network/index.ts

@@ -1,15 +1,15 @@
 import { NetworkLogTab } from './NetworkLogTab';
 
-import type { DebugFeature, NetworkLogEntry } from '../../types';
+import type { NetworkLogEntry } from '../../types';
+import { createChannelFeature } from '../../utils/createChannelFeature';
 import { createEventChannel } from '../../utils/createEventChannel';
-import { createPersistedObservableStore } from '../../utils/createPersistedObservableStore';
 import { KEYS } from '../../utils/debugPreferences';
-import { urlRewriter } from '../../utils/urlRewriterRegistry';
 import {
   startXMLHttpRequest,
   resetInterceptors,
 } from './networkInterceptor';
 import type { NetworkLogPayload } from './networkInterceptor';
+import { setUrlRewriter as setInterceptorUrlRewriter } from '../../utils/urlRewriter';
 
 // ─── Utilities ────────────────────────────────────────
 
@@ -35,7 +35,6 @@ function emitNetworkLog(entry: NetworkLogPayload): void {
 
 // ─── Feature factory ──────────────────────────────────
 
-const DEFAULT_MAX_LOGS = 200;
 const daemonEndpointBlacklist: Array<string | RegExp> = [];
 
 export interface NetworkFeatureConfig {
@@ -45,54 +44,33 @@ export interface NetworkFeatureConfig {
   blacklist?: Array<string | RegExp>;
 }
 
-export const createNetworkFeature = (config?: NetworkFeatureConfig): DebugFeature<NetworkLogEntry[]> => {
-  const maxLogs = config?.maxLogs ?? DEFAULT_MAX_LOGS;
-  const blacklist: Array<string | RegExp> = config?.blacklist ? [...config.blacklist] : [];
-  const logStore = createPersistedObservableStore<NetworkLogEntry>({
-    storageKey: KEYS.networkLogs,
-    maxPersist: 30,
-  });
-  let initialized = false;
-  let unsubscribeLogs: (() => void) | null = null;
-  let stopXhrFn: (() => void) | null = null;
-
-  const handleLog = (entry: NetworkLogPayload) => {
-    if (isUrlBlacklisted(entry.request.url, [...blacklist, ...daemonEndpointBlacklist])) {
-      return;
-    }
-    logStore.push({ ...entry, id: logStore.nextId() }, maxLogs);
-  };
-
-  return {
-    name: 'network',
-    label: 'Network',
-    renderContent: NetworkLogTab,
-    setup: () => {
-      if (initialized) {
-        return;
-      }
-      unsubscribeLogs = networkChannel.subscribe(handleLog);
-      stopXhrFn = startXMLHttpRequest(emitNetworkLog);
-      initialized = true;
+export const createNetworkFeature = (config?: NetworkFeatureConfig) => {
+  const userBlacklist = config?.blacklist ? [...config.blacklist] : [];
+
+  return createChannelFeature<NetworkLogPayload, NetworkLogEntry>(
+    () => networkChannel,
+    (payload, id) => ({ ...payload, id }),
+    {
+      name: 'network',
+      label: 'Network',
+      renderContent: NetworkLogTab,
+      maxLogs: config?.maxLogs,
+      persist: { storageKey: KEYS.networkLogs, maxPersist: 30 },
+      beforePush: (payload) => {
+        if (isUrlBlacklisted(payload.request.url, [...userBlacklist, ...daemonEndpointBlacklist])) {
+          return null;
+        }
+        return payload;
+      },
+      onSetup: () => {
+        const stopXhr = startXMLHttpRequest(emitNetworkLog);
+        return () => {
+          setInterceptorUrlRewriter(null);
+          stopXhr();
+        };
+      },
     },
-    getSnapshot: () => logStore.getData(),
-    clear: () => {
-      logStore.clear();
-    },
-    cleanup: () => {
-      if (!initialized) {
-        return;
-      }
-      urlRewriter.set(null);
-      unsubscribeLogs?.();
-      unsubscribeLogs = null;
-      stopXhrFn?.();
-      stopXhrFn = null;
-      logStore.clear();
-      initialized = false;
-    },
-    subscribe: (listener) => logStore.subscribe(listener),
-  };
+  );
 };
 
 function normalizeDaemonEndpoint(endpoint: string): string {
@@ -109,7 +87,7 @@ function normalizeDaemonEndpoint(endpoint: string): string {
   }
 }
 
-export function _addDaemonEndpointToNetworkBlacklist(endpoint: string): void {
+export function addToBlacklist(endpoint: string): void {
   const normalized = normalizeDaemonEndpoint(endpoint);
   if (!normalized || daemonEndpointBlacklist.includes(normalized)) {
     return;

package/src/features/network/networkInterceptor.ts

@@ -1,5 +1,5 @@
 import type { NetworkLogEntry } from '../../types';
-import { urlRewriter } from '../../utils/urlRewriterRegistry';
+import { getUrlRewriter } from '../../utils/urlRewriter';
 
 type NetworkLogPayload = Omit<NetworkLogEntry, 'id'>;
 
@@ -11,7 +11,7 @@ export type { NetworkLogPayload };
 // ─── Shared helpers ────────────────────────────────────
 
 function rewriteUrl(url: string): string {
-  const rewriter = urlRewriter.get();
+  const rewriter = getUrlRewriter();
   if (!rewriter) {
     return url;
   }
@@ -193,7 +193,7 @@ export function startXMLHttpRequest(
     url: string,
     ...args: unknown[]
   ) {
-    const rewrittenUrl = urlRewriter.get() ? rewriteUrl(url) : url;
+    const rewrittenUrl = rewriteUrl(url);
     if (shouldIgnoreUrl(rewrittenUrl)) {
       return originalXhrOpen!.call(this, method, rewrittenUrl, ...args);
     }

package/src/index.ts

@@ -42,21 +42,16 @@ export type {
   ReportResult,
   ReportToDaemonOptions,
 } from './utils/DaemonClient';
-export {
-  getDefaultDaemonEndpoint,
-  reportDebugDeviceToDaemon,
-  checkDaemonConnection,
-  startStreaming,
-  stopStreaming,
-  isStreaming,
-} from './utils/DaemonClient';
+export { getDefaultDaemonEndpoint } from './utils/DaemonClient';
 
 // Types
 export type {
   AnyDebugFeature,
   BuiltInFeatureName,
   DebugFeature,
+  DebugFeatureListener,
   DebugFeatureRenderProps,
+  FeatureDataProvider,
   NetworkLogEntry,
   ConsoleLogEntry,
   ZustandLogEntry,

package/src/types/feature.ts

@@ -19,6 +19,12 @@ export interface DebugFeatureRenderProps<TSnapshot = unknown> {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type AnyDebugFeature = DebugFeature<any>;
 
+/** Provides feature list and change notifications to consumers (e.g., DaemonClient). */
+export interface FeatureDataProvider {
+  readonly features: AnyDebugFeature[];
+  subscribe(listener: DebugFeatureListener): () => void;
+}
+
 export interface DebugFeature<TSnapshot = unknown> {
   name: string;
   label: string;

package/src/types/index.ts

@@ -4,6 +4,7 @@ export type {
   DebugFeature,
   DebugFeatureListener,
   DebugFeatureRenderProps,
+  FeatureDataProvider,
 } from './feature';
 
 export type {

package/src/utils/DaemonClient.ts

@@ -1,6 +1,7 @@
 import { AppState, type AppStateStatus, Platform } from 'react-native';
 
-import { DebugToolkit } from '../core/DebugToolkit';
+import { debugToolkit } from '../core/DebugToolkit';
+import type { FeatureDataProvider } from '../types';
 import {
   createDebugDeviceReport,
   type DebugDeviceReport,
@@ -164,6 +165,7 @@ interface StreamState {
 export interface DaemonClientOptions {
   fetch?: FetchLike;
   AbortController?: AbortControllerCtor;
+  featureProvider: FeatureDataProvider;
   onEndpointDetected?: (url: string) => void;
 }
 
@@ -178,13 +180,15 @@ export class DaemonClient {
   private _stream: StreamState | null = null;
   private _fetch: FetchLike | undefined;
   private _AbortController: AbortControllerCtor | undefined;
+  private _featureProvider: FeatureDataProvider;
   private _onEndpointDetected: ((url: string) => void) | undefined;
   private _restorePromise: Promise<void> | null = null;
 
-  constructor(options?: DaemonClientOptions) {
-    this._fetch = options?.fetch;
-    this._AbortController = options?.AbortController;
-    this._onEndpointDetected = options?.onEndpointDetected;
+  constructor(options: DaemonClientOptions) {
+    this._fetch = options.fetch;
+    this._AbortController = options.AbortController;
+    this._featureProvider = options.featureProvider;
+    this._onEndpointDetected = options.onEndpointDetected;
   }
 
   // --- Settings ---
@@ -291,7 +295,7 @@ export class DaemonClient {
       onStatus: options.onStatus,
     };
 
-    for (const feature of DebugToolkit.features) {
+    for (const feature of this._featureProvider.features) {
       if (!feature.subscribe) continue;
       const unsub = feature.subscribe(() => { this.onFeatureChange(feature.name); });
       state.featureUnsubscribes.push(unsub);
@@ -625,7 +629,7 @@ export class DaemonClient {
   }
 
   private async doSendFullReport(state: StreamState): Promise<SendResult> {
-    const report = createDebugDeviceReport();
+    const report = createDebugDeviceReport({ featureProvider: this._featureProvider });
     const response = await this.doPost(
       state.reportUrl,
       this.fetchHeaders(state),
@@ -648,7 +652,7 @@ export class DaemonClient {
     }
 
     state.lastSentIds.clear();
-    for (const feature of DebugToolkit.features) {
+    for (const feature of this._featureProvider.features) {
       try {
         const snapshot = feature.getSnapshot();
         if (Array.isArray(snapshot)) {
@@ -673,7 +677,7 @@ export class DaemonClient {
       try {
         const delta: Record<string, unknown[]> = {};
         const nextSentIds = new Map<string, Set<string | number>>();
-        const features = DebugToolkit.features;
+        const features = this._featureProvider.features;
 
         for (const featureName of state.dirtyFeatures) {
           const feature = features.find((f) => f.name === featureName);
@@ -769,53 +773,7 @@ export class DaemonClient {
 
 // ---- Module-level Singleton ----
 
-export const daemonClient = new DaemonClient();
-
-// ---- Backward-compatible Function Exports ----
-
-export async function loadDaemonSettings(): Promise<DaemonSettings> {
-  return daemonClient.getSettings();
-}
-
-export async function saveDaemonSettings(settings: DaemonSettings): Promise<void> {
-  daemonClient.configure(settings);
-}
-
-export async function loadDaemonStreamingEnabled(): Promise<boolean | null> {
-  return null;
-}
-
-export async function saveDaemonStreamingEnabled(enabled: boolean): Promise<void> {
-  daemonClient.setStreamingEnabled(enabled);
-}
-
-export function startStreaming(options: StreamToDaemonOptions = {}): void {
-  daemonClient.connect(options);
-}
-
-export function stopStreaming(): void {
-  daemonClient.disconnect();
-}
-
-export function isStreaming(): boolean {
-  return daemonClient.isConnected();
-}
-
-export function checkDaemonConnection(
-  options: DaemonConnectionOptions = {},
-): Promise<DaemonConnectionResult> {
-  return daemonClient.checkConnection(options);
-}
-
-export function reportDebugDeviceToDaemon(
-  options: ReportToDaemonOptions = {},
-): Promise<ReportResult> {
-  return daemonClient.reportOnce(options);
-}
-
-export function restoreDaemonStreaming(): Promise<void> {
-  return daemonClient.restore();
-}
+export const daemonClient = new DaemonClient({ featureProvider: debugToolkit });
 
 // ---- Internal Helpers ----
 

package/src/utils/createChannelFeature.ts

@@ -30,6 +30,10 @@ export function createChannelFeature<TPayload, TEntry extends { id?: string }>(
     renderContent?: ComponentType<DebugFeatureRenderProps<TEntry[]>>;
     maxLogs?: number;
     persist?: ChannelFeaturePersistConfig<TEntry>;
+    /** Return null to skip, or the (possibly modified) payload to proceed. */
+    beforePush?: (payload: TPayload) => TPayload | null;
+    /** Called after channel subscription in setup. Return a cleanup function. */
+    onSetup?: () => (() => void) | void;
   },
 ): DebugFeature<TEntry[]> {
   const maxLogs = options.maxLogs ?? DEFAULT_MAX_LOGS;
@@ -53,6 +57,7 @@ export function createChannelFeature<TPayload, TEntry extends { id?: string }>(
 
   let initialized = false;
   let unsubscribe: (() => void) | null = null;
+  let customCleanup: (() => void) | null = null;
 
   return {
     name: options.name,
@@ -61,8 +66,12 @@ export function createChannelFeature<TPayload, TEntry extends { id?: string }>(
     setup: () => {
       if (initialized) return;
       unsubscribe = getChannel().subscribe((payload) => {
-        logStore.push(toEntry(payload, getId()), maxLogs);
+        const filtered = options.beforePush ? options.beforePush(payload) : payload;
+        if (filtered == null) return;
+        logStore.push(toEntry(filtered, getId()), maxLogs);
       });
+      const cleanup = options.onSetup?.();
+      if (cleanup) customCleanup = cleanup;
       initialized = true;
     },
     getSnapshot: () => logStore.getData(),
@@ -70,6 +79,8 @@ export function createChannelFeature<TPayload, TEntry extends { id?: string }>(
       logStore.clear();
     },
     cleanup: () => {
+      customCleanup?.();
+      customCleanup = null;
       unsubscribe?.();
       unsubscribe = null;
       logStore.clear();

package/src/utils/deviceReport.ts

@@ -1,6 +1,7 @@
 import { Platform } from 'react-native';
 
-import { DebugToolkit } from '../core/DebugToolkit';
+import { debugToolkit } from '../core/DebugToolkit';
+import type { FeatureDataProvider } from '../types';
 import { safeStringify } from './safeStringify';
 
 const DEFAULT_MAX_PER_TYPE = 50;
@@ -160,14 +161,15 @@ function sanitizeValue(
 }
 
 export function createDebugDeviceReport(
-  options: DebugDeviceReportOptions = {},
+  options: DebugDeviceReportOptions & { featureProvider?: FeatureDataProvider } = {},
 ): DebugDeviceReport {
+  const provider = options.featureProvider ?? debugToolkit;
   const maxPerType = Math.max(1, Math.floor(options.maxPerType ?? DEFAULT_MAX_PER_TYPE));
   const maxBodyBytes = Math.max(256, Math.floor(options.maxBodyBytes ?? DEFAULT_MAX_BODY_BYTES));
   const includeTypes = options.includeTypes?.length ? new Set(options.includeTypes) : null;
   const logs: DebugDeviceReport['logs'] = {};
 
-  DebugToolkit.features.forEach((feature) => {
+  provider.features.forEach((feature) => {
     if (includeTypes && !includeTypes.has(feature.name)) {
       return;
     }

package/src/utils/urlRewriter.ts

@@ -0,0 +1,11 @@
+type UrlRewriter = (url: string) => string;
+
+let _urlRewriter: UrlRewriter | null = null;
+
+export function getUrlRewriter(): UrlRewriter | null {
+  return _urlRewriter;
+}
+
+export function setUrlRewriter(rewriter: UrlRewriter | null): void {
+  _urlRewriter = rewriter;
+}

package/lib/commonjs/utils/urlRewriterRegistry.js

@@ -1,14 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.urlRewriter = void 0;
-let current = null;
-const urlRewriter = exports.urlRewriter = {
-  get: () => current,
-  set: rewriter => {
-    current = rewriter;
-  }
-};
-//# sourceMappingURL=urlRewriterRegistry.js.map

package/lib/commonjs/utils/urlRewriterRegistry.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["current","urlRewriter","exports","get","set","rewriter"],"sourceRoot":"../../../src","sources":["utils/urlRewriterRegistry.ts"],"mappings":";;;;;;AAEA,IAAIA,OAA2B,GAAG,IAAI;AAE/B,MAAMC,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG;EACzBE,GAAG,EAAEA,CAAA,KAA0BH,OAAO;EACtCI,GAAG,EAAGC,QAA4B,IAAW;IAC3CL,OAAO,GAAGK,QAAQ;EACpB;AACF,CAAC","ignoreList":[]}

package/lib/module/utils/urlRewriterRegistry.js

@@ -1,10 +0,0 @@
-"use strict";
-
-let current = null;
-export const urlRewriter = {
-  get: () => current,
-  set: rewriter => {
-    current = rewriter;
-  }
-};
-//# sourceMappingURL=urlRewriterRegistry.js.map

package/lib/module/utils/urlRewriterRegistry.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["current","urlRewriter","get","set","rewriter"],"sourceRoot":"../../../src","sources":["utils/urlRewriterRegistry.ts"],"mappings":";;AAEA,IAAIA,OAA2B,GAAG,IAAI;AAEtC,OAAO,MAAMC,WAAW,GAAG;EACzBC,GAAG,EAAEA,CAAA,KAA0BF,OAAO;EACtCG,GAAG,EAAGC,QAA4B,IAAW;IAC3CJ,OAAO,GAAGI,QAAQ;EACpB;AACF,CAAC","ignoreList":[]}

package/lib/typescript/src/utils/urlRewriterRegistry.d.ts

@@ -1,7 +0,0 @@
-type UrlRewriter = (url: string) => string;
-export declare const urlRewriter: {
-    get: () => UrlRewriter | null;
-    set: (rewriter: UrlRewriter | null) => void;
-};
-export {};
-//# sourceMappingURL=urlRewriterRegistry.d.ts.map

package/lib/typescript/src/utils/urlRewriterRegistry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"urlRewriterRegistry.d.ts","sourceRoot":"","sources":["../../../../src/utils/urlRewriterRegistry.ts"],"names":[],"mappings":"AAAA,KAAK,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;AAI3C,eAAO,MAAM,WAAW;eACb,WAAW,GAAG,IAAI;oBACX,WAAW,GAAG,IAAI,KAAG,IAAI;CAG1C,CAAC"}

package/src/utils/urlRewriterRegistry.ts

@@ -1,10 +0,0 @@
-type UrlRewriter = (url: string) => string;
-
-let current: UrlRewriter | null = null;
-
-export const urlRewriter = {
-  get: (): UrlRewriter | null => current,
-  set: (rewriter: UrlRewriter | null): void => {
-    current = rewriter;
-  },
-};