fix: provider name typo

Author: sourabpramanik

CHANGELOG.md

@@ -7,8 +7,8 @@ All notable changes to this project will be documented in this file.
 ### 🚀 Features
 
 - Api key
-- Adds robolox auth provider
-- Adds robolox auth provider
+- Adds roblox auth provider
+- Adds roblox auth provider
 - Updates build process
 
 ### 🐛 Bug Fixes

examples/with-website/src/components/AfterLogin/index.tsx

@@ -1,18 +1,17 @@
 'use client'
 
 import './styles.scss'
-import React from 'react'
 
-import { Button } from '@payloadcms/ui'
 import { adminAuthClient } from '@/lib/auth'
+import { Button } from '@payloadcms/ui'
 
 export const AdminLogin = () => {
   const { oauth } = adminAuthClient.signin()
 
   const handleGoogleSignin = async () => oauth('google')
   const handleAuth0Signin = async () => oauth('auth0')
   const handleMicrosoftSignin = async () => oauth('msft-entra')
-  const handleRoboloxSignin = async () => oauth('robolox')
+  const handleRobloxSignin = async () => oauth('roblox')
 
   return (
     <div className="oauth-container">
@@ -25,8 +24,8 @@ export const AdminLogin = () => {
       <Button type="button" onClick={handleMicrosoftSignin} className="oauth-btn">
         Signin with Microsoft
       </Button>
-      <Button type="button" onClick={handleRoboloxSignin} className="oauth-btn">
-        Signin with Robolox
+      <Button type="button" onClick={handleRobloxSignin} className="oauth-btn">
+        Signin with Roblox
       </Button>
     </div>
   )

examples/with-website/src/plugins/index.ts

@@ -1,33 +1,33 @@
+import { revalidateRedirects } from '@/hooks/revalidateRedirects'
+import { beforeSyncWithSearch } from '@/search/beforeSync'
+import { searchFields } from '@/search/fieldOverrides'
 import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
 import { formBuilderPlugin } from '@payloadcms/plugin-form-builder'
 import { nestedDocsPlugin } from '@payloadcms/plugin-nested-docs'
 import { redirectsPlugin } from '@payloadcms/plugin-redirects'
-import { seoPlugin } from '@payloadcms/plugin-seo'
 import { searchPlugin } from '@payloadcms/plugin-search'
-import type { Plugin } from 'payload'
-import { revalidateRedirects } from '@/hooks/revalidateRedirects'
+import { seoPlugin } from '@payloadcms/plugin-seo'
 import type { GenerateTitle, GenerateURL } from '@payloadcms/plugin-seo/types'
 import { FixedToolbarFeature, HeadingFeature, lexicalEditor } from '@payloadcms/richtext-lexical'
-import { searchFields } from '@/search/fieldOverrides'
-import { beforeSyncWithSearch } from '@/search/beforeSync'
+import type { Plugin } from 'payload'
 
+import { AdminUsers } from '@/collections/Auth/Admin/Users'
 import type { Page, Post } from '@/payload-types'
 import { getServerSideURL } from '@/utilities/getURL'
-import { AdminUsers } from '@/collections/Auth/Admin/Users'
 
+import { AdminAccounts } from '@/collections/Auth/Admin/Accounts'
+import { AppUsersAccounts } from '@/collections/Auth/App/Accounts'
+import { AppUsers } from '@/collections/Auth/App/Users'
+import { renderForgotPasswordTemplate } from '@/templates/forgot-password'
 import { authPlugin } from 'payload-auth-plugin'
 import {
   Auth0AuthProvider,
   GoogleAuthProvider,
   MicrosoftEntraAuthProvider,
   PasswordProvider,
+  RobloxAuthProvider,
   TwitchAuthProvider,
-  RoboloxAuthProvider,
 } from 'payload-auth-plugin/providers'
-import { AdminAccounts } from '@/collections/Auth/Admin/Accounts'
-import { AppUsers } from '@/collections/Auth/App/Users'
-import { AppUsersAccounts } from '@/collections/Auth/App/Accounts'
-import { renderForgotPasswordTemplate } from '@/templates/forgot-password'
 
 const generateTitle: GenerateTitle<Post | Page> = ({ doc }) => {
   return doc?.title ? `${doc.title} | Payload Website Template` : 'Payload Website Template'
@@ -114,7 +114,7 @@ export const plugins: Plugin[] = [
     successRedirectPath: '/',
     errorRedirectPath: '/auth/signin',
     providers: [
-      RoboloxAuthProvider({
+      RobloxAuthProvider({
         client_id: process.env.ROBOLOX_CLIENT_ID as string,
         client_secret: process.env.ROBOLOX_CLIENT_SECRET as string,
       }),

src/client/oauth.ts

@@ -23,7 +23,7 @@ export type OauthProvider =
   | "jumpcloud"
   | "twitch"
   | "okta"
-  | "robolox"
+  | "roblox"
 
 export const oauth = (options: BaseOptions, provider: OauthProvider): void => {
   const additionalScope = options.additionalScope || ""

src/providers/index.ts

@@ -1,41 +1,26 @@
-import GoogleAuthProvider from "./oidc/google.js"
-import GitHubAuthProvider from "./oauth2/github.js"
-import GitLabAuthProvider from "./oidc/gitlab.js"
+import AppleOAuth2Provider from "./oauth2/apple.js"
 import AtlassianAuthProvider from "./oauth2/atlassian.js"
+import Auth0AuthProvider from "./oauth2/auth0.js"
 import DiscordAuthProvider from "./oauth2/discord.js"
 import FacebookAuthProvider from "./oauth2/facebook.js"
-import SlackAuthProvider from "./oidc/slack.js"
-import Auth0AuthProvider from "./oauth2/auth0.js"
-import OktaAuthProvider from "./oidc/okta.js"
+import GitHubAuthProvider from "./oauth2/github.js"
+import JumpCloudAuthProvider from "./oauth2/jumpcloud.js"
+import RobloxAuthProvider from "./oauth2/roblox.js"
+import TwitchAuthProvider from "./oauth2/twitch.js"
+import AppleOIDCAuthProvider from "./oidc/apple.js"
 import CognitoAuthProvider from "./oidc/cognito.js"
+import GitLabAuthProvider from "./oidc/gitlab.js"
+import GoogleAuthProvider from "./oidc/google.js"
 import KeyCloakAuthProvider from "./oidc/keycloak.js"
-import PasskeyAuthProvider from "./passkey.js"
 import MicrosoftEntraAuthProvider from "./oidc/microsoft-entra.js"
-import AppleOIDCAuthProvider from "./oidc/apple.js"
-import AppleOAuth2Provider from "./oauth2/apple.js"
-import JumpCloudAuthProvider from "./oauth2/jumpcloud.js"
-import TwitchAuthProvider from "./oauth2/twitch.js"
+import OktaAuthProvider from "./oidc/okta.js"
+import SlackAuthProvider from "./oidc/slack.js"
+import PasskeyAuthProvider from "./passkey.js"
 import PasswordProvider from "./password.js"
-import RoboloxAuthProvider from "./oauth2/robolox.js"
 
 export {
-  GoogleAuthProvider,
-  GitHubAuthProvider,
-  GitLabAuthProvider,
-  AtlassianAuthProvider,
-  DiscordAuthProvider,
-  FacebookAuthProvider,
-  SlackAuthProvider,
-  Auth0AuthProvider,
-  CognitoAuthProvider,
-  KeyCloakAuthProvider,
-  PasskeyAuthProvider,
-  MicrosoftEntraAuthProvider,
-  AppleOIDCAuthProvider,
-  AppleOAuth2Provider,
-  JumpCloudAuthProvider,
-  TwitchAuthProvider,
-  PasswordProvider,
-  OktaAuthProvider,
-  RoboloxAuthProvider,
+  AppleOAuth2Provider, AppleOIDCAuthProvider, AtlassianAuthProvider, Auth0AuthProvider,
+  CognitoAuthProvider, DiscordAuthProvider,
+  FacebookAuthProvider, GitHubAuthProvider,
+  GitLabAuthProvider, GoogleAuthProvider, JumpCloudAuthProvider, KeyCloakAuthProvider, MicrosoftEntraAuthProvider, OktaAuthProvider, PasskeyAuthProvider, PasswordProvider, RobloxAuthProvider, SlackAuthProvider, TwitchAuthProvider
 }

src/providers/oauth2/robolox.ts src/providers/oauth2/roblox.tssrc/providers/oauth2/robolox.ts renamed to src/providers/oauth2/roblox.ts

@@ -4,9 +4,8 @@ import type {
   OAuth2ProviderConfig,
   OAuthBaseProviderConfig,
 } from "../../types.js"
-import { defaultTimezones } from "payload/shared"
 
-type RoboloxAuthConfig = OAuthBaseProviderConfig
+type RobloxAuthConfig = OAuthBaseProviderConfig
 
 const authorization_server: AuthorizationServer = {
   issuer: "https://apis.roblox.com/oauth/",
@@ -16,25 +15,25 @@ const authorization_server: AuthorizationServer = {
 }
 
 /**
- * Add Robolox OAuth2 Provider
+ * Add Roblox OAuth2 Provider
  *
  * #### Callback or Redirect URL pattern
  *
  * ```
- * https://example.com/api/{name}/oauth/callback/robolox
+ * https://example.com/api/{name}/oauth/callback/roblox
  * ```
  *
  * #### Plugin Setup
  *
  * ```ts
  * import { Plugin } from 'payload'
  * import {authPlugin} from "payload-auth-plugin"
- * import {RoboloxAuthProvider} from "payload-auth-plugin/providers"
+ * import {RobloxAuthProvider} from "payload-auth-plugin/providers"
  *
  * export const plugins: Plugin[] = [
  *  authPlugin({
  *    providers:[
- *      RoboloxAuthProvider({
+ *      RobloxAuthProvider({
  *          client_id: process.env.ROBOLOX_CLIENT_ID as string,
  *          client_secret: process.env.ROBOLOR_CLIENT_SECRET as string,
  *      })
@@ -45,15 +44,15 @@ const authorization_server: AuthorizationServer = {
  *
  */
 
-function RoboloxAuthProvider(config: RoboloxAuthConfig): OAuth2ProviderConfig {
+function RobloxAuthProvider(config: RobloxAuthConfig): OAuth2ProviderConfig {
   const { overrideScope, ...restConfig } = config
 
   return {
     ...restConfig,
-    id: "robolox",
+    id: "roblox",
     scope: overrideScope ?? "openid email profile",
     authorization_server,
-    name: "Robolox",
+    name: "Roblox",
     algorithm: "oauth2",
     kind: "oauth",
     profile: (profile): AccountInfo => {
@@ -67,4 +66,4 @@ function RoboloxAuthProvider(config: RoboloxAuthConfig): OAuth2ProviderConfig {
   }
 }
 
-export default RoboloxAuthProvider
+export default RobloxAuthProvider