@react-devtools-plus/scan 0.2.0

package/src/index.ts

@@ -0,0 +1,134 @@
+/**
+ * React DevTools Scan - Integration layer for react-scan
+ *
+ * @packageDocumentation
+ */
+
+import type { IntegrationMode, ReactDevtoolsScanOptions, ScanInstance } from './types'
+import { getOptions, ReactScanInternals, scan, setOptions } from 'react-scan'
+import { getScanInstance, resetScanInstance } from './adapter'
+
+/**
+ * Initialize React Scan with DevTools integration
+ *
+ * @param options - Configuration options for React Scan
+ * @returns Scan instance for further control
+ *
+ * @example
+ * ```typescript
+ * import { initScan } from '@react-devtools-plus/scan';
+ *
+ * // Initialize with default options
+ * const scanInstance = initScan();
+ *
+ * // Initialize with custom options
+ * const scanInstance = initScan({
+ *   enabled: true,
+ *   showToolbar: true,
+ *   animationSpeed: 'fast',
+ *   trackUnnecessaryRenders: true,
+ *   integrationMode: 'overlay'
+ * });
+ * ```
+ */
+export function initScan(options: ReactDevtoolsScanOptions = {}): ScanInstance {
+  // Set default options
+  const defaultOptions: ReactDevtoolsScanOptions = {
+    enabled: process.env.NODE_ENV === 'development',
+    integrationMode: 'overlay',
+    syncWithDevtools: true,
+    ...options,
+  }
+
+  if (typeof window !== 'undefined') {
+    // Check if already initialized (Singleton pattern)
+    if ((window as any).__REACT_SCAN_INTERNALS__) {
+      // Ensure runInAllEnvironments is true on existing instance
+      const existingInternals = (window as any).__REACT_SCAN_INTERNALS__
+      if (existingInternals) {
+        existingInternals.runInAllEnvironments = true
+      }
+
+      // Update options on existing instance
+      const setOpts = (window as any).__REACT_SCAN_SET_OPTIONS__
+      if (setOpts) {
+        setOpts(defaultOptions)
+      }
+
+      // Return adapter for existing instance
+      return getScanInstance(defaultOptions)
+    }
+
+    // Manually expose internals to window for DevTools integration
+    ;(window as any).__REACT_SCAN_INTERNALS__ = ReactScanInternals
+    ;(window as any).__REACT_SCAN_SET_OPTIONS__ = setOptions
+    ;(window as any).__REACT_SCAN_GET_OPTIONS__ = getOptions
+    ;(window as any).__REACT_SCAN_SCAN__ = scan
+  }
+
+  // Initialize scan with the options
+  scan(defaultOptions)
+
+  // Return the scan instance for further control
+  return getScanInstance(defaultOptions)
+}
+
+/**
+ * Get the current scan instance
+ *
+ * @returns Current scan instance or null if not initialized
+ *
+ * @example
+ * ```typescript
+ * import { getScan } from '@react-devtools-plus/scan';
+ *
+ * const scanInstance = getScan();
+ * if (scanInstance) {
+ *   // Check if scan is active
+ *   scanInstance.isActive();
+ * }
+ * ```
+ */
+export function getScan(): ScanInstance | null {
+  try {
+    return getScanInstance()
+  }
+  catch {
+    return null
+  }
+}
+
+/**
+ * Reset the scan instance (useful for testing)
+ *
+ * @example
+ * ```typescript
+ * import { resetScan } from '@react-devtools-plus/scan';
+ *
+ * // Reset for testing
+ * resetScan();
+ * ```
+ */
+export function resetScan(): void {
+  resetScanInstance()
+}
+
+// Re-export types
+export type { IntegrationMode, ReactDevtoolsScanOptions, ScanInstance }
+
+// Re-export plugin
+export { createScanPlugin, scanPlugin } from './plugin'
+export type { ScanPluginConfig } from './plugin'
+
+// Re-export react-scan exports for convenience
+export {
+  getOptions,
+  onRender,
+  ReactScanInternals, // Export Internals for advanced integration
+  scan,
+  setOptions,
+  useScan,
+} from 'react-scan'
+
+// Re-export react-scan types
+export type { Options } from 'react-scan'