Update OAuth API (#776)

lucia-auth · Jun 23, 2023 · c520b5d · c520b5d
1 parent 151cdf5
commit c520b5d
Show file tree

Hide file tree

Showing 14 changed files with 126 additions and 114 deletions.
diff --git a/.auri/$1j735d60.md b/.auri/$1j735d60.md
@@ -0,0 +1,6 @@
+---
+package: "@lucia-auth/oauth" # package name
+type: "major" # "major", "minor", "patch"
+---
+
+Rename `providerUser` property to `<provider_name>User` (`githubUser` etc)
diff --git a/.auri/$40a7umh0.md b/.auri/$40a7umh0.md
@@ -0,0 +1,6 @@
+---
+package: "@lucia-auth/oauth" # package name
+type: "major" # "major", "minor", "patch"
+---
+
+Rename `useAuth()` to `providerUserAuth()`
diff --git a/.auri/$yf495wr1.md b/.auri/$yf495wr1.md
@@ -0,0 +1,6 @@
+---
+package: "@lucia-auth/oauth" # package name
+type: "major" # "major", "minor", "patch"
+---
+
+Rename `tokens` property to `<provider_name>Tokens` (`githubTokens` etc)
diff --git a/packages/oauth/src/core.ts b/packages/oauth/src/core.ts
@@ -9,20 +9,14 @@ export type OAuthConfig = {
 	scope?: string[];
 };
 
-export type OAuthProvider<A extends Auth> = {
+export type OAuthProvider = {
 	validateCallback: (
 		code: string,
 		...args: any[]
 	) => Promise<{
-		existingUser: LuciaUser<A> | null;
-		createUser: (
-			attributes: CreateUserAttributesParameter<A>
-		) => Promise<LuciaUser<A>>;
+		existingUser: Record<any, any> | null;
+		createUser: (attributes: Record<string, any>) => Promise<Record<any, any>>;
 		createKey: (userId: string) => Promise<Key>;
-		providerUser: Record<string, any>;
-		tokens: {
-			accessToken: string;
-		};
 	}>;
 	getAuthorizationUrl: (
 		redirectUri?: string
@@ -48,7 +42,7 @@ export const scope = (base: string[], config: string[] = []) => {
 	return [...base, ...(config ?? [])].join(" ");
 };
 
-export const useAuth = async <_Auth extends Auth>(
+export const providerUserAuth = async <_Auth extends Auth>(
 	auth: _Auth,
 	providerId: string,
 	providerUserId: string

diff --git a/packages/oauth/src/index.ts b/packages/oauth/src/index.ts
@@ -1,3 +1,3 @@
-export { generateState, OAuthRequestError, useAuth } from "./core.js";
+export { generateState, OAuthRequestError, providerUserAuth } from "./core.js";
 
 export type { OAuthProvider } from "./core.js";
diff --git a/packages/oauth/src/providers/auth0.ts b/packages/oauth/src/providers/auth0.ts
@@ -1,5 +1,5 @@
 import { createUrl, handleRequest, authorizationHeaders } from "../request.js";
-import { scope, generateState, useAuth } from "../core.js";
+import { scope, generateState, providerUserAuth } from "../core.js";
 
 import type { Auth } from "lucia";
 import type { OAuthConfig, OAuthProvider } from "../core.js";
@@ -16,7 +16,7 @@ type Config = OAuthConfig & {
 };
 
 export const auth0 = <_Auth extends Auth>(auth: _Auth, config: Config) => {
-	const getTokens = async (code: string) => {
+	const getAuth0Tokens = async (code: string) => {
 		const request = new Request(new URL("/oauth/token", config.appDomain), {
 			method: "POST",
 			headers: {
@@ -45,7 +45,7 @@ export const auth0 = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 		};
 	};
 
-	const getProviderUser = async (accessToken: string) => {
+	const getAuth0User = async (accessToken: string) => {
 		const request = new Request(new URL("/userinfo", config.appDomain), {
 			headers: authorizationHeaders("bearer", accessToken)
 		});
@@ -83,21 +83,21 @@ export const auth0 = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 			return [url, state] as const;
 		},
 		validateCallback: async (code: string) => {
-			const tokens = await getTokens(code);
-			const providerUser = await getProviderUser(tokens.accessToken);
-			const providerUserId = providerUser.id;
-			const providerAuthHelpersHelpers = await useAuth(
+			const auth0Tokens = await getAuth0Tokens(code);
+			const auth0User = await getAuth0User(auth0Tokens.accessToken);
+			const providerUserId = auth0User.id;
+			const auth0UserAuth = await providerUserAuth(
 				auth,
 				PROVIDER_ID,
 				providerUserId
 			);
 			return {
-				...providerAuthHelpersHelpers,
-				providerUser,
-				tokens
+				...auth0UserAuth,
+				auth0User,
+				auth0Tokens
 			};
 		}
-	} as const satisfies OAuthProvider<_Auth>;
+	} as const satisfies OAuthProvider;
 };
 
 type Auth0Profile = {

diff --git a/packages/oauth/src/providers/discord.ts b/packages/oauth/src/providers/discord.ts
@@ -1,5 +1,5 @@
 import { createUrl, handleRequest, authorizationHeaders } from "../request.js";
-import { useAuth, generateState, scope } from "../core.js";
+import { providerUserAuth, generateState, scope } from "../core.js";
 
 import type { Auth } from "lucia";
 import type { OAuthConfig, OAuthProvider } from "../core.js";
@@ -11,7 +11,7 @@ type Config = OAuthConfig & {
 const PROVIDER_ID = "discord";
 
 export const discord = <_Auth extends Auth>(auth: _Auth, config: Config) => {
-	const getTokens = async (code: string) => {
+	const getDiscordTokens = async (code: string) => {
 		const request = new Request("https://discord.com/api/oauth2/token", {
 			method: "POST",
 			headers: {
@@ -38,7 +38,7 @@ export const discord = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 		};
 	};
 
-	const getProviderUser = async (accessToken: string) => {
+	const getDiscordUser = async (accessToken: string) => {
 		// do not use oauth/users/@me because it ignores intents, use oauth/users/@me instead
 		const request = new Request("https://discord.com/api/users/@me", {
 			headers: authorizationHeaders("bearer", accessToken)
@@ -60,21 +60,21 @@ export const discord = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 			return [url, state];
 		},
 		validateCallback: async (code: string) => {
-			const tokens = await getTokens(code);
-			const providerUser = await getProviderUser(tokens.accessToken);
-			const providerUserId = providerUser.id;
-			const providerAuthHelpers = await useAuth(
+			const discordTokens = await getDiscordTokens(code);
+			const discordUser = await getDiscordUser(discordTokens.accessToken);
+			const providerUserId = discordUser.id;
+			const discordUserAuth = await providerUserAuth(
 				auth,
 				PROVIDER_ID,
 				providerUserId
 			);
 			return {
-				...providerAuthHelpers,
-				providerUser,
-				tokens
+				...discordUserAuth,
+				discordUser,
+				discordTokens
 			};
 		}
-	} as const satisfies OAuthProvider<_Auth>;
+	} as const satisfies OAuthProvider;
 };
 
 export type DiscordUser = {

diff --git a/packages/oauth/src/providers/facebook.ts b/packages/oauth/src/providers/facebook.ts
@@ -1,5 +1,5 @@
 import { createUrl, handleRequest, authorizationHeaders } from "../request.js";
-import { scope, generateState, useAuth } from "../core.js";
+import { scope, generateState, providerUserAuth } from "../core.js";
 
 import type { Auth } from "lucia";
 import type { OAuthConfig, OAuthProvider } from "../core.js";
@@ -11,7 +11,7 @@ type Config = OAuthConfig & {
 const PROVIDER_ID = "facebook";
 
 export const facebook = <_Auth extends Auth>(auth: _Auth, config: Config) => {
-	const getTokens = async (code: string) => {
+	const getFacebookTokens = async (code: string) => {
 		const requestUrl = createUrl(
 			"https://graph.facebook.com/v16.0/oauth/access_token",
 			{
@@ -35,7 +35,7 @@ export const facebook = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 		};
 	};
 
-	const getProviderUser = async (accessToken: string) => {
+	const getFacebookUser = async (accessToken: string) => {
 		const requestUrl = createUrl("https://graph.facebook.com/me", {
 			access_token: accessToken,
 			fields: ["id", "name", "picture"].join(",")
@@ -59,21 +59,21 @@ export const facebook = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 			return [url, state] as const;
 		},
 		validateCallback: async (code: string) => {
-			const tokens = await getTokens(code);
-			const providerUser = await getProviderUser(tokens.accessToken);
-			const providerUserId = providerUser.id;
-			const providerAuthHelpers = await useAuth(
+			const tokens = await getFacebookTokens(code);
+			const facebookUser = await getFacebookUser(tokens.accessToken);
+			const providerUserId = facebookUser.id;
+			const facebookUserAuth = await providerUserAuth(
 				auth,
 				PROVIDER_ID,
 				providerUserId
 			);
 			return {
-				...providerAuthHelpers,
-				providerUser,
+				...facebookUserAuth,
+				facebookUser,
 				tokens
 			};
 		}
-	} as const satisfies OAuthProvider<_Auth>;
+	} as const satisfies OAuthProvider;
 };
 
 export type FacebookUser = {

diff --git a/packages/oauth/src/providers/github.ts b/packages/oauth/src/providers/github.ts
@@ -1,5 +1,5 @@
 import { createUrl, handleRequest, authorizationHeaders } from "../request.js";
-import { scope, generateState, useAuth } from "../core.js";
+import { scope, generateState, providerUserAuth } from "../core.js";
 
 import type { Auth } from "lucia";
 import type { OAuthConfig, OAuthProvider } from "../core.js";
@@ -23,7 +23,7 @@ type Config = OAuthConfig & {
 };
 
 export const github = <_Auth extends Auth>(auth: _Auth, config: Config) => {
-	const getTokens = async (code: string): Promise<Tokens> => {
+	const getGithubTokens = async (code: string): Promise<Tokens> => {
 		const requestUrl = createUrl(
 			"https://github.com/login/oauth/access_token",
 			{
@@ -63,7 +63,7 @@ export const github = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 		};
 	};
 
-	const getProviderUser = async (accessToken: string) => {
+	const getGithubUser = async (accessToken: string) => {
 		const request = new Request("https://api.github.com/user", {
 			headers: authorizationHeaders("bearer", accessToken)
 		});
@@ -85,21 +85,21 @@ export const github = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 			return [url, state] as const;
 		},
 		validateCallback: async (code: string) => {
-			const tokens = await getTokens(code);
-			const providerUser = await getProviderUser(tokens.accessToken);
-			const providerUserId = providerUser.id.toString();
-			const providerAuthHelpers = await useAuth(
+			const githubTokens = await getGithubTokens(code);
+			const githubUser = await getGithubUser(githubTokens.accessToken);
+			const providerUserId = githubUser.id.toString();
+			const githubUserAuth = await providerUserAuth(
 				auth,
 				PROVIDER_ID,
 				providerUserId
 			);
 			return {
-				...providerAuthHelpers,
-				providerUser,
-				tokens
+				...githubUserAuth,
+				githubUser,
+				githubTokens
 			};
 		}
-	} as const satisfies OAuthProvider<_Auth>;
+	} as const satisfies OAuthProvider;
 };
 
 type PublicGithubUser = {

diff --git a/packages/oauth/src/providers/google.ts b/packages/oauth/src/providers/google.ts
@@ -1,5 +1,5 @@
 import { createUrl, handleRequest, authorizationHeaders } from "../request.js";
-import { scope, generateState, useAuth } from "../core.js";
+import { scope, generateState, providerUserAuth } from "../core.js";
 
 import type { Auth } from "lucia";
 import type { OAuthConfig, OAuthProvider } from "../core.js";
@@ -11,7 +11,7 @@ type Config = OAuthConfig & {
 const PROVIDER_ID = "google";
 
 export const google = <_Auth extends Auth>(auth: _Auth, config: Config) => {
-	const getTokens = async (code: string) => {
+	const getGoogleTokens = async (code: string) => {
 		const requestUrl = createUrl("https://oauth2.googleapis.com/token", {
 			client_id: config.clientId,
 			client_secret: config.clientSecret,
@@ -35,7 +35,7 @@ export const google = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 		};
 	};
 
-	const getProviderUser = async (accessToken: string) => {
+	const getGoogleUser = async (accessToken: string) => {
 		const request = new Request(
 			"https://www.googleapis.com/oauth2/v3/userinfo",
 			{
@@ -62,21 +62,21 @@ export const google = <_Auth extends Auth>(auth: _Auth, config: Config) => {
 			return [url, state] as const;
 		},
 		validateCallback: async (code: string) => {
-			const tokens = await getTokens(code);
-			const providerUser = await getProviderUser(tokens.accessToken);
-			const providerUserId = providerUser.sub;
-			const providerAuthHelpers = await useAuth(
+			const googleTokens = await getGoogleTokens(code);
+			const googleUser = await getGoogleUser(googleTokens.accessToken);
+			const providerUserId = googleUser.sub;
+			const googleUserAuth = await providerUserAuth(
 				auth,
 				PROVIDER_ID,
 				providerUserId
 			);
 			return {
-				...providerAuthHelpers,
-				providerUser,
-				tokens
+				...googleUserAuth,
+				googleUser,
+				googleTokens
 			};
 		}
-	} as const satisfies OAuthProvider<_Auth>;
+	} as const satisfies OAuthProvider;
 };
 
 export type GoogleUser = {