Chore: Implement naming convention for createClient functions

.changeset/six-eggs-search.md

@@ -0,0 +1,5 @@
+---
+'@supabase/auth-helpers-nextjs': patch
+---
+
+[BREAKING CHANGES]: Renamed createBrowserSupabaseClient to createPagesBrowserClient, createServerSupabaseClient to createPagesServerClient and createMiddlewareSupabaseClient to createMiddlewareClient

packages/nextjs/src/browserClient.ts → packages/nextjs/src/clientComponentClient.ts

@@ -5,7 +5,7 @@ import {
 	createSupabaseClient
 } from '@supabase/auth-helpers-shared';
 
-export function createBrowserSupabaseClient<
+export function createClientComponentClient<
 	Database = any,
 	SchemaName extends string & keyof Database = 'public' extends keyof Database
 		? 'public'

packages/nextjs/src/deprecated.ts

@@ -0,0 +1,106 @@
+import {
+	SupabaseClientOptionsWithoutAuth,
+	CookieOptionsWithName
+} from '@supabase/auth-helpers-shared';
+import { createPagesBrowserClient } from './pagesBrowserClient';
+import { createPagesServerClient } from './pagesServerClient';
+import { GetServerSidePropsContext, NextApiRequest, NextApiResponse } from 'next';
+import { NextRequest, NextResponse } from 'next/server';
+import { createMiddlewareClient } from './middlewareClient';
+
+/**
+ * @deprecated utilize the `createPagesBrowserClient` function instead
+ */
+export function createBrowserSupabaseClient<
+	Database = any,
+	SchemaName extends string & keyof Database = 'public' extends keyof Database
+		? 'public'
+		: string & keyof Database
+>({
+	supabaseUrl = process.env.NEXT_PUBLIC_SUPABASE_URL,
+	supabaseKey = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
+	options,
+	cookieOptions
+}: {
+	supabaseUrl?: string;
+	supabaseKey?: string;
+	options?: SupabaseClientOptionsWithoutAuth<SchemaName>;
+	cookieOptions?: CookieOptionsWithName;
+} = {}) {
+	console.warn(
+		'Please utilize the `createPagesBrowserClient` function instead of the deprecated `createBrowserSupabaseClient` function.'
+	);
+	return createPagesBrowserClient<Database, SchemaName>({
+		supabaseUrl,
+		supabaseKey,
+		options,
+		cookieOptions
+	});
+}
+
+/**
+ * @deprecated utilize the `createPagesServerClient` function instead
+ */
+export function createServerSupabaseClient<
+	Database = any,
+	SchemaName extends string & keyof Database = 'public' extends keyof Database
+		? 'public'
+		: string & keyof Database
+>(
+	context: GetServerSidePropsContext | { req: NextApiRequest; res: NextApiResponse },
+	{
+		supabaseUrl = process.env.NEXT_PUBLIC_SUPABASE_URL,
+		supabaseKey = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
+		options,
+		cookieOptions
+	}: {
+		supabaseUrl?: string;
+		supabaseKey?: string;
+		options?: SupabaseClientOptionsWithoutAuth<SchemaName>;
+		cookieOptions?: CookieOptionsWithName;
+	} = {}
+) {
+	console.warn(
+		'Please utilize the `createPagesServerClient` function instead of the deprecated `createServerSupabaseClient` function.'
+	);
+	return createPagesServerClient<Database, SchemaName>(context, {
+		supabaseUrl,
+		supabaseKey,
+		options,
+		cookieOptions
+	});
+}
+
+/**
+ * @deprecated utilize the `createMiddlewareClient` function instead
+ */
+export function createMiddlewareSupabaseClient<
+	Database = any,
+	SchemaName extends string & keyof Database = 'public' extends keyof Database
+		? 'public'
+		: string & keyof Database
+>(
+	context: { req: NextRequest; res: NextResponse },
+	{
+		supabaseUrl = process.env.NEXT_PUBLIC_SUPABASE_URL,
+		supabaseKey = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
+		options,
+		cookieOptions
+	}: {
+		supabaseUrl?: string;
+		supabaseKey?: string;
+		options?: SupabaseClientOptionsWithoutAuth<SchemaName>;
+		cookieOptions?: CookieOptionsWithName;
+	} = {}
+) {
+	console.warn(
+		'Please utilize the `createMiddlewareClient function instead of the deprecated `createMiddlewareSupabaseClient` function.'
+	);
+
+	return createMiddlewareClient<Database, SchemaName>(context, {
+		supabaseUrl,
+		supabaseKey,
+		options,
+		cookieOptions
+	});
+}

packages/nextjs/src/index.ts

@@ -9,9 +9,17 @@ export type WritableRequestCookies = ReadonlyRequestCookies & {
 	set: (name: string, value: string, options?: CookieOptions) => void;
 };
 
-export { createBrowserSupabaseClient } from './browserClient';
-export { createServerSupabaseClient } from './serverClient';
-export { createMiddlewareSupabaseClient } from './middlewareClient';
-export { createServerComponentSupabaseClient } from './serverComponentClient';
-export { createRouteHandlerSupabaseClient } from './routeHandlerClient';
-export { createServerActionSupabaseClient } from './serverActionClient';
+export { createPagesBrowserClient } from './pagesBrowserClient';
+export { createPagesServerClient } from './pagesServerClient';
+export { createMiddlewareClient } from './middlewareClient';
+export { createClientComponentClient } from './clientComponentClient';
+export { createServerComponentClient } from './serverComponentClient';
+export { createRouteHandlerClient } from './routeHandlerClient';
+export { createServerActionClient } from './serverActionClient';
+
+// Deprecated Functions
+export {
+	createBrowserSupabaseClient,
+	createServerSupabaseClient,
+	createMiddlewareSupabaseClient
+} from './deprecated';

packages/nextjs/src/middlewareClient.ts

@@ -53,7 +53,7 @@ class NextMiddlewareAuthStorageAdapter extends CookieAuthStorageAdapter {
 	}
 }
 
-export function createMiddlewareSupabaseClient<
+export function createMiddlewareClient<
 	Database = any,
 	SchemaName extends string & keyof Database = 'public' extends keyof Database
 		? 'public'

packages/nextjs/src/pagesBrowserClient.ts

@@ -0,0 +1,3 @@
+import { createClientComponentClient } from './clientComponentClient';
+
+export const createPagesBrowserClient = createClientComponentClient;

packages/nextjs/src/serverClient.ts → packages/nextjs/src/pagesServerClient.ts

@@ -53,7 +53,7 @@ class NextServerAuthStorageAdapter extends CookieAuthStorageAdapter {
 	}
 }
 
-export function createServerSupabaseClient<
+export function createPagesServerClient<
 	Database = any,
 	SchemaName extends string & keyof Database = 'public' extends keyof Database
 		? 'public'

packages/nextjs/src/routeHandlerClient.ts

@@ -35,7 +35,7 @@ class NextRouteHandlerAuthStorageAdapter extends CookieAuthStorageAdapter {
 	}
 }
 
-export function createRouteHandlerSupabaseClient<
+export function createRouteHandlerClient<
 	Database = any,
 	SchemaName extends string & keyof Database = 'public' extends keyof Database
 		? 'public'

packages/nextjs/src/serverActionClient.ts

@@ -1,3 +1,3 @@
-import { createRouteHandlerSupabaseClient } from './routeHandlerClient';
+import { createRouteHandlerClient } from './routeHandlerClient';
 
-export const createServerActionSupabaseClient = createRouteHandlerSupabaseClient;
+export const createServerActionClient = createRouteHandlerClient;

packages/nextjs/src/serverComponentClient.ts

@@ -34,9 +34,7 @@ class NextServerComponentAuthStorageAdapter extends CookieAuthStorageAdapter {
 	}
 }
 
-export const createRouteHandlerSupabaseClient = createServerComponentSupabaseClient;
-
-export function createServerComponentSupabaseClient<
+export function createServerComponentClient<
 	Database = any,
 	SchemaName extends string & keyof Database = 'public' extends keyof Database
 		? 'public'