Add Roblox provider (#88)

* add roblox provider

* format

.changesets/94a8i.minor.md

@@ -0,0 +1 @@
+Add Roblox provider.

.changesets/hu3zn.minor.md

@@ -1 +1 @@
-Add VK provider.
+Add VK provider.

.github/FUNDING.yml

@@ -1 +1 @@
-github: pilcrowOnPaper
+github: pilcrowOnPaper

CONTRIBUTING.md

@@ -6,7 +6,7 @@ We welcome all contributions to the docs, especially grammar fixes. Arctic uses
 
 ## Contributing to the source code
 
-We are open to most contributions, but please open a new issue before creating a pull request, especially for new features.  It's likely your PR will be rejected if not. We have intentionally limited the scope of the project and we would like to keep the package lean.
+We are open to most contributions, but please open a new issue before creating a pull request, especially for new features. It's likely your PR will be rejected if not. We have intentionally limited the scope of the project and we would like to keep the package lean.
 
 ### Set up
 

docs/malta.config.json

@@ -42,6 +42,7 @@
 				["osu!", "/providers/osu"],
 				["Patreon", "/providers/patreon"],
 				["Reddit", "/providers/reddit"],
+				["Roblox", "/providers/roblox"],
 				["Salesforce", "/providers/salesforce"],
 				["Slack", "/providers/slack"],
 				["Spotify", "/providers/spotify"],

docs/pages/providers/roblox.md

@@ -0,0 +1,46 @@
+---
+title: "Roblox"
+---
+
+# Roblox
+
+Implements OpenID Connect. For confidential clients and not public clients.
+
+For usage, see [OAuth 2.0 provider with PKCE](/guides/oauth2-pkce).
+
+```ts
+import { Roblox } from "arctic";
+
+const roblox = new Roblox(clientId, clientSecret, redirectURI);
+```
+
+```ts
+const url: URL = await roblox.createAuthorizationURL(state, codeVerifier, {
+	// optional
+	scopes // "openid" always included
+});
+const tokens: RobloxTokens = await roblox.validateAuthorizationCode(code, codeVerifier);
+const tokens: RobloxTokens = await roblox.refreshAccessToken(refreshToken);
+```
+
+## Get user profile
+
+Add the `profile` scope.
+
+```ts
+const url = await roblox.createAuthorizationURL(state, codeVerifier, {
+	scopes: ["profile"]
+});
+```
+
+Parse the ID token or use the [`userinfo` endpoint](https://create.roblox.com/docs/cloud/reference/oauth2#get-v1userinfo).
+
+```ts
+const tokens = await roblox.validateAuthorizationCode(code, codeVerifier);
+const response = await fetch("https://apis.roblox.com/oauth/v1/userinfo", {
+	headers: {
+		Authorization: `Bearer ${tokens.accessToken}`
+	}
+});
+const user = await response.json();
+```

docs/pages/providers/yandex.md

@@ -36,4 +36,4 @@ const response = await fetch("https://api.tracker.yandex.net/v2/myself", {
 	}
 });
 const user = await response.json();
-```
+```

src/index.ts

@@ -25,6 +25,7 @@ export { Okta } from "./providers/okta.js";
 export { Osu } from "./providers/osu.js";
 export { Patreon } from "./providers/patreon.js";
 export { Reddit } from "./providers/reddit.js";
+export { Roblox } from "./providers/roblox.js";
 export { Salesforce } from "./providers/salesforce.js";
 export { Slack } from "./providers/slack.js";
 export { Spotify } from "./providers/spotify.js";
@@ -68,6 +69,7 @@ export type { OktaTokens } from "./providers/okta.js";
 export type { OsuTokens } from "./providers/osu.js";
 export type { PatreonTokens } from "./providers/patreon.js";
 export type { RedditTokens } from "./providers/reddit.js";
+export type { RobloxTokens } from "./providers/roblox.js";
 export type { SalesforceTokens } from "./providers/salesforce.js";
 export type { SlackTokens } from "./providers/slack.js";
 export type { SpotifyTokens } from "./providers/spotify.js";

src/providers/roblox.ts

@@ -0,0 +1,78 @@
+import { TimeSpan, createDate } from "oslo";
+import { OAuth2Client } from "oslo/oauth2";
+
+import type { OAuth2ProviderWithPKCE } from "../index.js";
+
+const authorizeEndpoint = "https://apis.roblox.com/oauth/v1/authorize";
+const tokenEndpoint = "https://apis.roblox.com/oauth/v1/token";
+
+export class Roblox implements OAuth2ProviderWithPKCE {
+	private client: OAuth2Client;
+	private clientSecret: string;
+
+	constructor(clientId: string, clientSecret: string, redirectURI: string) {
+		this.client = new OAuth2Client(clientId, authorizeEndpoint, tokenEndpoint, {
+			redirectURI
+		});
+		this.clientSecret = clientSecret;
+	}
+
+	public async createAuthorizationURL(
+		state: string,
+		codeVerifier: string,
+		options?: {
+			scopes?: string[];
+		}
+	): Promise<URL> {
+		const scopes = options?.scopes ?? [];
+		return await this.client.createAuthorizationURL({
+			state,
+			codeVerifier,
+			scopes: [...scopes, "openid"]
+		});
+	}
+
+	public async validateAuthorizationCode(
+		code: string,
+		codeVerifier: string
+	): Promise<RobloxTokens> {
+		const result = await this.client.validateAuthorizationCode<TokenResponseBody>(code, {
+			credentials: this.clientSecret,
+			codeVerifier
+		});
+		const tokens: RobloxTokens = {
+			accessToken: result.access_token,
+			refreshToken: result.refresh_token,
+			accessTokenExpiresAt: createDate(new TimeSpan(result.expires_in, "s")),
+			idToken: result.id_token
+		};
+		return tokens;
+	}
+
+	public async refreshAccessToken(refreshToken: string): Promise<RobloxTokens> {
+		const result = await this.client.refreshAccessToken<TokenResponseBody>(refreshToken, {
+			credentials: this.clientSecret
+		});
+		const tokens: RobloxTokens = {
+			accessToken: result.access_token,
+			refreshToken: result.refresh_token,
+			accessTokenExpiresAt: createDate(new TimeSpan(result.expires_in, "s")),
+			idToken: result.id_token
+		};
+		return tokens;
+	}
+}
+
+interface TokenResponseBody {
+	access_token: string;
+	refresh_token: string;
+	expires_in: number;
+	id_token: string;
+}
+
+export interface RobloxTokens {
+	accessToken: string;
+	refreshToken: string;
+	accessTokenExpiresAt: Date;
+	idToken: string;
+}

src/providers/yandex.ts

@@ -10,9 +10,13 @@ export class Yandex implements OAuth2Provider {
 	private client: OAuth2Client;
 	private clientSecret: string;
 
-	constructor(clientId: string, clientSecret: string, options?: {
-        redirectURI: string
-    }) {
+	constructor(
+		clientId: string,
+		clientSecret: string,
+		options?: {
+			redirectURI: string;
+		}
+	) {
 		this.client = new OAuth2Client(clientId, authorizeEndpoint, tokenEndpoint, {
 			redirectURI: options?.redirectURI
 		});
@@ -27,7 +31,7 @@ export class Yandex implements OAuth2Provider {
 	): Promise<URL> {
 		return await this.client.createAuthorizationURL({
 			state,
-			scopes: options?.scopes ?? [],
+			scopes: options?.scopes ?? []
 		});
 	}