chore: update README and BrowserEchoScript to reflect new default route for Next.js integration

regenrek · regenrek · commit 068ddf12f5a9 · 2025-08-12T14:03:43.000+02:00
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ type BrowserLogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
 
 interface BrowserEchoOptions {
   enabled?: boolean;                 // default: true (dev only)
-  route?: `/${string}`;              // default: '/__client-logs'
+  route?: `/${string}`;              // default: '/api/client-logs' (Next), '/__client-logs' (others)
   include?: BrowserLogLevel[];       // default: ['log','info','warn','error','debug']
   preserveConsole?: boolean;         // default: true (also keep logging in the browser)
   tag?: string;                      // default: '[browser]'
@@ -75,7 +75,7 @@ interface BrowserEchoOptions {
 
   * Vite: ensure plugin is added and either `index.html` exists or you import the virtual module manually.
   * Nuxt: confirm the module is in `modules[]` and you’re in dev mode.
-  * Next: make sure `app/__client-logs/route.ts` is exported and `<BrowserEchoScript />` is rendered in `<head>`.
+* Next: make sure `app/api/client-logs/route.ts` is exported and `<BrowserEchoScript />` is rendered in `<head>`.
 
 * Endpoint 404
 
diff --git a/packages/next/README.md b/packages/next/README.md
@@ -42,7 +42,7 @@ type BrowserLogLevel = 'log' | 'info' | 'warn' | 'error' | 'debug';
 
 interface BrowserEchoScriptProps {
   enabled?: boolean;                 // default: true (dev only)
-  route?: `/${string}`;              // default: '/__client-logs'
+  route?: `/${string}`;              // default: '/api/client-logs'
   include?: BrowserLogLevel[];       // default: ['log','info','warn','error','debug']
   preserveConsole?: boolean;         // default: true (also keep logging in the browser)
   tag?: string;                      // default: '[browser]'
@@ -142,7 +142,7 @@ Forward logs to your terminal via a dedicated route:
 export { POST, runtime, dynamic } from '@browser-echo/next/route';
 ```
 
-- Route defaults to `/__client-logs` but works better as `/api/client-logs` in Next.js 15+
+- Default route is `/api/client-logs` (works best in Next.js 15+)
 - We set `runtime = 'nodejs'` and `dynamic = 'force-dynamic'` to ensure it runs on Node and isn't cached
 
 ## Usage Example
@@ -210,7 +210,7 @@ This package depends on [@browser-echo/core](https://github.com/instructa/browse
 
 ## Troubleshooting
 
-- **No logs appear**: Make sure `app/__client-logs/route.ts` is exported and `<BrowserEchoScript />` is rendered in `<head>`
+- **No logs appear**: Make sure `app/api/client-logs/route.ts` is exported and `<BrowserEchoScript />` is rendered in `<head>`
 - **Endpoint 404**: Verify your route file path matches the script's `route` prop
 - **Too noisy**: Limit to `include: ['warn','error']` and use `stackMode: 'condensed'`
 
diff --git a/packages/next/src/BrowserEchoScript.tsx b/packages/next/src/BrowserEchoScript.tsx
@@ -21,7 +21,8 @@ export default function BrowserEchoScript(props: BrowserEchoScriptProps): JSX.El
     return <></>;
   }
 
-  const route = props.route ?? '/__client-logs';
+  // Default to the conventional Next.js API route path
+  const route = props.route ?? '/api/client-logs';
   const include = JSON.stringify(props.include ?? ['log','info','warn','error','debug']);
   const preserve = props.preserveConsole ?? true;
   const tag = props.tag ?? '[browser]';
diff --git a/packages/next/src/setup.ts b/packages/next/src/setup.ts
@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { existsSync, mkdirSync, writeFileSync } from 'fs';
-import { join } from 'path';
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
 
 const ROUTE_CONTENT = `export { POST, runtime, dynamic } from '@browser-echo/next/route';
 `;
@@ -56,7 +56,11 @@ export function setup(projectRoot = process.cwd()) {
 `);
 }
 
-// Run if called directly
-if (require.main === module) {
+// Run if called directly (ESM-safe)
+const isDirectRun = typeof process !== 'undefined'
+  && Array.isArray(process.argv)
+  && (process.argv[1]?.endsWith('setup.mjs') || process.argv[1]?.endsWith('setup.js'));
+
+if (isDirectRun) {
   setup();
 }

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ export default function BrowserEchoScript(props: BrowserEchoScriptProps): JSX.El`
`21`	`21`	`return <></>;`
`22`	`22`	`}`
`23`	`23`
`24`		`- const route = props.route ?? '/__client-logs';`
	`24`	`+ // Default to the conventional Next.js API route path`
	`25`	`+ const route = props.route ?? '/api/client-logs';`
`25`	`26`	`const include = JSON.stringify(props.include ?? ['log','info','warn','error','debug']);`
`26`	`27`	`const preserve = props.preserveConsole ?? true;`
`27`	`28`	`const tag = props.tag ?? '[browser]';`