@gatwech/core 0.0.11 → 1.0.0-beta.19

package/src/social-providers/tiktok.ts

@@ -1,210 +0,0 @@
-import { betterFetch } from "@better-fetch/fetch";
-import type { OAuthProvider, ProviderOptions } from "../oauth2";
-import { refreshAccessToken, validateAuthorizationCode } from "../oauth2";
-
-/**
- * [More info](https://developers.tiktok.com/doc/tiktok-api-v2-get-user-info/)
- */
-export interface TiktokProfile extends Record<string, any> {
-	data: {
-		user: {
-			/**
-			 * The unique identification of the user in the current application.Open id
-			 * for the client.
-			 *
-			 * To return this field, add `fields=open_id` in the user profile request's query parameter.
-			 */
-			open_id: string;
-			/**
-			 * The unique identification of the user across different apps for the same developer.
-			 * For example, if a partner has X number of clients,
-			 * it will get X number of open_id for the same TikTok user,
-			 * but one persistent union_id for the particular user.
-			 *
-			 * To return this field, add `fields=union_id` in the user profile request's query parameter.
-			 */
-			union_id?: string | undefined;
-			/**
-			 * User's profile image.
-			 *
-			 * To return this field, add `fields=avatar_url` in the user profile request's query parameter.
-			 */
-			avatar_url?: string | undefined;
-			/**
-			 * User`s profile image in 100x100 size.
-			 *
-			 * To return this field, add `fields=avatar_url_100` in the user profile request's query parameter.
-			 */
-			avatar_url_100?: string | undefined;
-			/**
-			 * User's profile image with higher resolution
-			 *
-			 * To return this field, add `fields=avatar_url_100` in the user profile request's query parameter.
-			 */
-			avatar_large_url: string;
-			/**
-			 * User's profile name
-			 *
-			 * To return this field, add `fields=display_name` in the user profile request's query parameter.
-			 */
-			display_name: string;
-			/**
-			 * User's username.
-			 *
-			 * To return this field, add `fields=username` in the user profile request's query parameter.
-			 */
-			username: string;
-			/** @note Email is currently unsupported by TikTok  */
-			email?: string | undefined;
-			/**
-			 * User's bio description if there is a valid one.
-			 *
-			 * To return this field, add `fields=bio_description` in the user profile request's query parameter.
-			 */
-			bio_description?: string | undefined;
-			/**
-			 * The link to user's TikTok profile page.
-			 *
-			 * To return this field, add `fields=profile_deep_link` in the user profile request's query parameter.
-			 */
-			profile_deep_link?: string | undefined;
-			/**
-			 * Whether TikTok has provided a verified badge to the account after confirming
-			 * that it belongs to the user it represents.
-			 *
-			 * To return this field, add `fields=is_verified` in the user profile request's query parameter.
-			 */
-			is_verified?: boolean | undefined;
-			/**
-			 * User's followers count.
-			 *
-			 * To return this field, add `fields=follower_count` in the user profile request's query parameter.
-			 */
-			follower_count?: number | undefined;
-			/**
-			 * The number of accounts that the user is following.
-			 *
-			 * To return this field, add `fields=following_count` in the user profile request's query parameter.
-			 */
-			following_count?: number | undefined;
-			/**
-			 * The total number of likes received by the user across all of their videos.
-			 *
-			 * To return this field, add `fields=likes_count` in the user profile request's query parameter.
-			 */
-			likes_count?: number | undefined;
-			/**
-			 * The total number of publicly posted videos by the user.
-			 *
-			 * To return this field, add `fields=video_count` in the user profile request's query parameter.
-			 */
-			video_count?: number | undefined;
-		};
-	};
-	error?:
-		| {
-				/**
-				 * The error category in string.
-				 */
-				code?: string;
-				/**
-				 * The error message in string.
-				 */
-				message?: string;
-				/**
-				 * The error message in string.
-				 */
-				log_id?: string;
-		  }
-		| undefined;
-}
-
-export interface TiktokOptions extends ProviderOptions {
-	// Client ID is not used in TikTok, we delete it from the options
-	clientId?: never | undefined;
-	clientSecret: string;
-	clientKey: string;
-}
-
-export const tiktok = (options: TiktokOptions) => {
-	return {
-		id: "tiktok",
-		name: "TikTok",
-		createAuthorizationURL({ state, scopes, redirectURI }) {
-			const _scopes = options.disableDefaultScope ? [] : ["user.info.profile"];
-			if (options.scope) _scopes.push(...options.scope);
-			if (scopes) _scopes.push(...scopes);
-			return new URL(
-				`https://www.tiktok.com/v2/auth/authorize?scope=${_scopes.join(
-					",",
-				)}&response_type=code&client_key=${options.clientKey}&redirect_uri=${encodeURIComponent(
-					options.redirectURI || redirectURI,
-				)}&state=${state}`,
-			);
-		},
-
-		validateAuthorizationCode: async ({ code, redirectURI }) => {
-			return validateAuthorizationCode({
-				code,
-				redirectURI: options.redirectURI || redirectURI,
-				options: {
-					clientKey: options.clientKey,
-					clientSecret: options.clientSecret,
-				},
-				tokenEndpoint: "https://open.tiktokapis.com/v2/oauth/token/",
-			});
-		},
-		refreshAccessToken: options.refreshAccessToken
-			? options.refreshAccessToken
-			: async (refreshToken) => {
-					return refreshAccessToken({
-						refreshToken,
-						options: {
-							clientSecret: options.clientSecret,
-						},
-						tokenEndpoint: "https://open.tiktokapis.com/v2/oauth/token/",
-						authentication: "post",
-						extraParams: {
-							client_key: options.clientKey,
-						},
-					});
-				},
-		async getUserInfo(token) {
-			if (options.getUserInfo) {
-				return options.getUserInfo(token);
-			}
-
-			const fields = [
-				"open_id",
-				"avatar_large_url",
-				"display_name",
-				"username",
-			];
-			const { data: profile, error } = await betterFetch<TiktokProfile>(
-				`https://open.tiktokapis.com/v2/user/info/?fields=${fields.join(",")}`,
-				{
-					headers: {
-						authorization: `Bearer ${token.accessToken}`,
-					},
-				},
-			);
-
-			if (error) {
-				return null;
-			}
-
-			return {
-				user: {
-					email: profile.data.user.email || profile.data.user.username,
-					id: profile.data.user.open_id,
-					name: profile.data.user.display_name || profile.data.user.username,
-					image: profile.data.user.avatar_large_url,
-					/** @note Tiktok does not provide emailVerified or even email*/
-					emailVerified: profile.data.user.email ? true : false,
-				},
-				data: profile,
-			};
-		},
-		options,
-	} satisfies OAuthProvider<TiktokProfile, TiktokOptions>;
-};

package/src/social-providers/twitch.ts

@@ -1,111 +0,0 @@
-import { decodeJwt } from "jose";
-import { logger } from "../env";
-import type { OAuthProvider, ProviderOptions } from "../oauth2";
-import {
-	createAuthorizationURL,
-	refreshAccessToken,
-	validateAuthorizationCode,
-} from "../oauth2";
-
-/**
- * @see https://dev.twitch.tv/docs/authentication/getting-tokens-oidc/#requesting-claims
- */
-export interface TwitchProfile {
-	/**
-	 * The sub of the user
-	 */
-	sub: string;
-	/**
-	 * The preferred username of the user
-	 */
-	preferred_username: string;
-	/**
-	 * The email of the user
-	 */
-	email: string;
-	/**
-	 * Indicate if this user has a verified email.
-	 */
-	email_verified: boolean;
-	/**
-	 * The picture of the user
-	 */
-	picture: string;
-}
-
-export interface TwitchOptions extends ProviderOptions<TwitchProfile> {
-	clientId: string;
-	claims?: string[] | undefined;
-}
-export const twitch = (options: TwitchOptions) => {
-	return {
-		id: "twitch",
-		name: "Twitch",
-		createAuthorizationURL({ state, scopes, redirectURI }) {
-			const _scopes = options.disableDefaultScope
-				? []
-				: ["user:read:email", "openid"];
-			if (options.scope) _scopes.push(...options.scope);
-			if (scopes) _scopes.push(...scopes);
-			return createAuthorizationURL({
-				id: "twitch",
-				redirectURI,
-				options,
-				authorizationEndpoint: "https://id.twitch.tv/oauth2/authorize",
-				scopes: _scopes,
-				state,
-				claims: options.claims || [
-					"email",
-					"email_verified",
-					"preferred_username",
-					"picture",
-				],
-			});
-		},
-		validateAuthorizationCode: async ({ code, redirectURI }) => {
-			return validateAuthorizationCode({
-				code,
-				redirectURI,
-				options,
-				tokenEndpoint: "https://id.twitch.tv/oauth2/token",
-			});
-		},
-		refreshAccessToken: options.refreshAccessToken
-			? options.refreshAccessToken
-			: async (refreshToken) => {
-					return refreshAccessToken({
-						refreshToken,
-						options: {
-							clientId: options.clientId,
-							clientKey: options.clientKey,
-							clientSecret: options.clientSecret,
-						},
-						tokenEndpoint: "https://id.twitch.tv/oauth2/token",
-					});
-				},
-		async getUserInfo(token) {
-			if (options.getUserInfo) {
-				return options.getUserInfo(token);
-			}
-			const idToken = token.idToken;
-			if (!idToken) {
-				logger.error("No idToken found in token");
-				return null;
-			}
-			const profile = decodeJwt(idToken) as TwitchProfile;
-			const userMap = await options.mapProfileToUser?.(profile);
-			return {
-				user: {
-					id: profile.sub,
-					name: profile.preferred_username,
-					email: profile.email,
-					image: profile.picture,
-					emailVerified: profile.email_verified,
-					...userMap,
-				},
-				data: profile,
-			};
-		},
-		options,
-	} satisfies OAuthProvider<TwitchProfile>;
-};

package/src/social-providers/twitter.ts

@@ -1,198 +0,0 @@
-import { betterFetch } from "@better-fetch/fetch";
-import type { OAuthProvider, ProviderOptions } from "../oauth2";
-import {
-	createAuthorizationURL,
-	refreshAccessToken,
-	validateAuthorizationCode,
-} from "../oauth2";
-
-export interface TwitterProfile {
-	data: {
-		/**
-		 * Unique identifier of this user. This is returned as a string in order to avoid complications with languages and tools
-		 * that cannot handle large integers.
-		 */
-		id: string;
-		/** The friendly name of this user, as shown on their profile. */
-		name: string;
-		/** The email address of this user. */
-		email?: string | undefined;
-		/** The Twitter handle (screen name) of this user. */
-		username: string;
-		/**
-		 * The location specified in the user's profile, if the user provided one.
-		 * As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries.
-		 *
-		 * To return this field, add `user.fields=location` in the authorization request's query parameter.
-		 */
-		location?: string | undefined;
-		/**
-		 * This object and its children fields contain details about text that has a special meaning in the user's description.
-		 *
-		 *To return this field, add `user.fields=entities` in the authorization request's query parameter.
-		 */
-		entities?:
-			| {
-					/** Contains details about the user's profile website. */
-					url: {
-						/** Contains details about the user's profile website. */
-						urls: Array<{
-							/** The start position (zero-based) of the recognized user's profile website. All start indices are inclusive. */
-							start: number;
-							/** The end position (zero-based) of the recognized user's profile website. This end index is exclusive. */
-							end: number;
-							/** The URL in the format entered by the user. */
-							url: string;
-							/** The fully resolved URL. */
-							expanded_url: string;
-							/** The URL as displayed in the user's profile. */
-							display_url: string;
-						}>;
-					};
-					/** Contains details about URLs, Hashtags, Cashtags, or mentions located within a user's description. */
-					description: {
-						hashtags: Array<{
-							start: number;
-							end: number;
-							tag: string;
-						}>;
-					};
-			  }
-			| undefined;
-		/**
-		 * Indicate if this user is a verified Twitter user.
-		 *
-		 * To return this field, add `user.fields=verified` in the authorization request's query parameter.
-		 */
-		verified?: boolean | undefined;
-		/**
-		 * The text of this user's profile description (also known as bio), if the user provided one.
-		 *
-		 * To return this field, add `user.fields=description` in the authorization request's query parameter.
-		 */
-		description?: string | undefined;
-		/**
-		 * The URL specified in the user's profile, if present.
-		 *
-		 * To return this field, add `user.fields=url` in the authorization request's query parameter.
-		 */
-		url?: string | undefined;
-		/** The URL to the profile image for this user, as shown on the user's profile. */
-		profile_image_url?: string | undefined;
-		protected?: boolean | undefined;
-		/**
-		 * Unique identifier of this user's pinned Tweet.
-		 *
-		 *  You can obtain the expanded object in `includes.tweets` by adding `expansions=pinned_tweet_id` in the authorization request's query parameter.
-		 */
-		pinned_tweet_id?: string | undefined;
-		created_at?: string | undefined;
-	};
-	includes?:
-		| {
-				tweets?: Array<{
-					id: string;
-					text: string;
-				}>;
-		  }
-		| undefined;
-	[claims: string]: unknown;
-}
-
-export interface TwitterOption extends ProviderOptions<TwitterProfile> {
-	clientId: string;
-}
-
-export const twitter = (options: TwitterOption) => {
-	return {
-		id: "twitter",
-		name: "Twitter",
-		createAuthorizationURL(data) {
-			const _scopes = options.disableDefaultScope
-				? []
-				: ["users.read", "tweet.read", "offline.access", "users.email"];
-			if (options.scope) _scopes.push(...options.scope);
-			if (data.scopes) _scopes.push(...data.scopes);
-			return createAuthorizationURL({
-				id: "twitter",
-				options,
-				authorizationEndpoint: "https://x.com/i/oauth2/authorize",
-				scopes: _scopes,
-				state: data.state,
-				codeVerifier: data.codeVerifier,
-				redirectURI: data.redirectURI,
-			});
-		},
-		validateAuthorizationCode: async ({ code, codeVerifier, redirectURI }) => {
-			return validateAuthorizationCode({
-				code,
-				codeVerifier,
-				authentication: "basic",
-				redirectURI,
-				options,
-				tokenEndpoint: "https://api.x.com/2/oauth2/token",
-			});
-		},
-
-		refreshAccessToken: options.refreshAccessToken
-			? options.refreshAccessToken
-			: async (refreshToken) => {
-					return refreshAccessToken({
-						refreshToken,
-						options: {
-							clientId: options.clientId,
-							clientKey: options.clientKey,
-							clientSecret: options.clientSecret,
-						},
-						authentication: "basic",
-						tokenEndpoint: "https://api.x.com/2/oauth2/token",
-					});
-				},
-		async getUserInfo(token) {
-			if (options.getUserInfo) {
-				return options.getUserInfo(token);
-			}
-			const { data: profile, error: profileError } =
-				await betterFetch<TwitterProfile>(
-					"https://api.x.com/2/users/me?user.fields=profile_image_url",
-					{
-						method: "GET",
-						headers: {
-							Authorization: `Bearer ${token.accessToken}`,
-						},
-					},
-				);
-
-			if (profileError) {
-				return null;
-			}
-
-			const { data: emailData, error: emailError } = await betterFetch<{
-				data: { confirmed_email: string };
-			}>("https://api.x.com/2/users/me?user.fields=confirmed_email", {
-				method: "GET",
-				headers: {
-					Authorization: `Bearer ${token.accessToken}`,
-				},
-			});
-			let emailVerified = false;
-			if (!emailError && emailData?.data?.confirmed_email) {
-				profile.data.email = emailData.data.confirmed_email;
-				emailVerified = true;
-			}
-			const userMap = await options.mapProfileToUser?.(profile);
-			return {
-				user: {
-					id: profile.data.id,
-					name: profile.data.name,
-					email: profile.data.email || profile.data.username || null,
-					image: profile.data.profile_image_url,
-					emailVerified: emailVerified,
-					...userMap,
-				},
-				data: profile,
-			};
-		},
-		options,
-	} satisfies OAuthProvider<TwitterProfile>;
-};

package/src/social-providers/vk.ts

@@ -1,126 +0,0 @@
-import { betterFetch } from "@better-fetch/fetch";
-import {
-	createAuthorizationURL,
-	type OAuthProvider,
-	type ProviderOptions,
-	refreshAccessToken,
-	validateAuthorizationCode,
-} from "../oauth2";
-
-export interface VkProfile {
-	user: {
-		user_id: string;
-		first_name: string;
-		last_name: string;
-		email?: string | undefined;
-		phone?: number | undefined;
-		avatar?: string | undefined;
-		sex?: number | undefined;
-		verified?: boolean | undefined;
-		birthday: string;
-	};
-}
-
-export interface VkOption extends ProviderOptions {
-	clientId: string;
-	scheme?: ("light" | "dark") | undefined;
-}
-
-export const vk = (options: VkOption) => {
-	return {
-		id: "vk",
-		name: "VK",
-		async createAuthorizationURL({ state, scopes, codeVerifier, redirectURI }) {
-			const _scopes = options.disableDefaultScope ? [] : ["email", "phone"];
-			if (options.scope) _scopes.push(...options.scope);
-			if (scopes) _scopes.push(...scopes);
-			const authorizationEndpoint = "https://id.vk.com/authorize";
-
-			return createAuthorizationURL({
-				id: "vk",
-				options,
-				authorizationEndpoint,
-				scopes: _scopes,
-				state,
-				redirectURI,
-				codeVerifier,
-			});
-		},
-		validateAuthorizationCode: async ({
-			code,
-			codeVerifier,
-			redirectURI,
-			deviceId,
-		}) => {
-			return validateAuthorizationCode({
-				code,
-				codeVerifier,
-				redirectURI: options.redirectURI || redirectURI,
-				options,
-				deviceId,
-				tokenEndpoint: "https://id.vk.com/oauth2/auth",
-			});
-		},
-		refreshAccessToken: options.refreshAccessToken
-			? options.refreshAccessToken
-			: async (refreshToken) => {
-					return refreshAccessToken({
-						refreshToken,
-						options: {
-							clientId: options.clientId,
-							clientKey: options.clientKey,
-							clientSecret: options.clientSecret,
-						},
-						tokenEndpoint: "https://id.vk.com/oauth2/auth",
-					});
-				},
-		async getUserInfo(data) {
-			if (options.getUserInfo) {
-				return options.getUserInfo(data);
-			}
-			if (!data.accessToken) {
-				return null;
-			}
-			const formBody = new URLSearchParams({
-				access_token: data.accessToken,
-				client_id: options.clientId,
-			}).toString();
-			const { data: profile, error } = await betterFetch<VkProfile>(
-				"https://id.vk.com/oauth2/user_info",
-				{
-					method: "POST",
-					headers: {
-						"Content-Type": "application/x-www-form-urlencoded",
-					},
-					body: formBody,
-				},
-			);
-			if (error) {
-				return null;
-			}
-
-			const userMap = await options.mapProfileToUser?.(profile);
-			if (!profile.user.email && !userMap?.email) {
-				return null;
-			}
-
-			return {
-				user: {
-					id: profile.user.user_id,
-					first_name: profile.user.first_name,
-					last_name: profile.user.last_name,
-					email: profile.user.email,
-					image: profile.user.avatar,
-					/** @note VK does not provide emailVerified*/
-					emailVerified: !!profile.user.email,
-					birthday: profile.user.birthday,
-					sex: profile.user.sex,
-					name: `${profile.user.first_name} ${profile.user.last_name}`,
-					...userMap,
-				},
-				data: profile,
-			};
-		},
-		options,
-	} satisfies OAuthProvider<VkProfile>;
-};