refactor: Add enableLocalStrategy plugin option instead of custom collection field

Author: CrawlerCode

packages/dev/src/payload.config.ts

@@ -52,5 +52,5 @@ export default buildConfig({
     },
   }),
   sharp,
-  plugins: [authjsPlugin({ authjsConfig: nodeAuthConfig })],
+  plugins: [authjsPlugin({ authjsConfig: nodeAuthConfig, enableLocalStrategy: true })],
 });

packages/dev/src/payload/collections/users.ts

@@ -15,9 +15,6 @@ const Users: CollectionConfig = {
   auth: {
     useAPIKey: true,
   },
-  custom: {
-    enableLocalStrategy: true,
-  },
   fields: [
     {
       name: "name",

packages/payload-authjs/src/authjs/PayloadAdapter.ts

@@ -66,8 +66,7 @@ export function PayloadAdapter({
 
       let payloadUser: User;
       if (
-        (await payload).collections[userCollectionSlug]?.config.custom.enableLocalStrategy ===
-          true &&
+        !(await payload).collections[userCollectionSlug]?.config.auth.disableLocalStrategy &&
         !(user as User).password
       ) {
         // If the local strategy is enabled and the user does not have a password, bypass the password check
@@ -406,10 +405,7 @@ export function PayloadAdapter({
           verificationTokens: [token],
         };
 
-        if (
-          (await payload).collections[userCollectionSlug]?.config.custom.enableLocalStrategy ===
-          true
-        ) {
+        if (!(await payload).collections[userCollectionSlug]?.config.auth.disableLocalStrategy) {
           // If the local strategy is enabled, bypass the password check
           payloadUser = (await createUserAndBypassPasswordCheck(payload, {
             collection: userCollectionSlug,

packages/payload-authjs/src/payload/collection/index.ts

@@ -95,7 +95,7 @@ export const generateUsersCollection = (
     ...authOptions,
     strategies: [AuthjsAuthStrategy(collection, pluginOptions), ...(authStrategies ?? [])],
     // Disable local strategy if not explicitly enabled
-    ...(collection.custom?.enableLocalStrategy === true ? {} : { disableLocalStrategy: true }),
+    ...(pluginOptions.enableLocalStrategy === true ? {} : { disableLocalStrategy: true }),
   };
 
   // Add hooks to users collection

packages/payload-authjs/src/payload/plugin.ts

@@ -28,6 +28,14 @@ export interface AuthjsPluginConfig {
    */
   authjsConfig: NextAuthConfig;
 
+  /**
+   * Enable the default local strategy from Payload CMS (experimental)
+   * @see https://payloadcms.com/docs/authentication/jwt
+   *
+   * @default false
+   */
+  enableLocalStrategy?: boolean;
+
   /**
    * Customize the components that the plugin adds to the admin panel
    */