better referrer tracking

Author: guillaumervls

packages/neondb/README.md

@@ -39,7 +39,11 @@ Create a claimable Neon Postgres database and save credentials to your .env:
 await instantNeon({
 	dotEnvFile: ".env",
 	dotEnvKey: "DATABASE_URL",
-	referrer: "my-scaffolder-cli",
+	// This below is to help us understand where usage comes from.
+	// If you're publishing a library, we'd love that you re-expose a
+	// referrer parameter in your lib and set this to `npm:your-lib-package-name|${referrer}`
+	// So we can understand the chain better and give you all the credit you deserve!
+	referrer: "npm:your-cli-package-name",
 });
 ```
 

packages/neondb/src/cli.ts

@@ -102,7 +102,7 @@ async function main() {
 		await instantNeon({
 			dotEnvFile: userInput.dotEnvPath,
 			dotEnvKey: userInput.dotEnvKey,
-			referrer: "neondb-cli",
+			referrer: "npm:neondb/cli",
 		});
 	}
 	s.stop("Database generated!");

packages/neondb/src/lib/instant-neon.ts

@@ -20,7 +20,10 @@ export const instantNeon = async ({
 	const dbId = randomUUID();
 	const claimExpiresAt = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000);
 	const createDbUrl = new URL(
-		LAUNCHPAD_URLS.CREATE_CLAIMABLE_DATABASE(dbId, referrer),
+		LAUNCHPAD_URLS.CREATE_CLAIMABLE_DATABASE(
+			dbId,
+			`npm:neondb|${referrer}`,
+		),
 	);
 	const claimUrl = new URL(LAUNCHPAD_URLS.CLAIM_DATABASE(dbId));
 	log.step(messages.botCheck(createDbUrl.href));

packages/vite-plugin-postgres/src/index.ts

@@ -6,19 +6,21 @@ import { loadEnv, type Plugin as VitePlugin } from "vite";
 interface PostgresPluginOptions {
 	env: string;
 	envKey: string;
+	referrer: string;
 }
 
 const DEFAULTS: PostgresPluginOptions = {
 	env: ".env",
 	envKey: "DATABASE_URL",
+	referrer: "unknown",
 };
 
 let claimProcessStarted = false;
 
 export default function postgresPlugin(
 	options?: Partial<PostgresPluginOptions>,
 ): VitePlugin {
-	const { env: envPath, envKey } = { ...DEFAULTS, ...options };
+	const { env: envPath, envKey, referrer } = { ...DEFAULTS, ...options };
 	return {
 		name: "@neondatabase/vite-plugin-postgres",
 
@@ -52,7 +54,7 @@ export default function postgresPlugin(
 			await instantNeon({
 				dotEnvFile: envPath,
 				dotEnvKey: envKey,
-				referrer: "@neondatabase/vite-plugin-postgres",
+				referrer: `npm:@neondatabase/vite-plugin-postgres|${referrer}`,
 			});
 			outro("Neon database created successfully.");
 		},