feat(withPayload): Add custom evens to withPayload function

Author: CrawlerCode

packages/dev/src/auth.ts

@@ -4,8 +4,24 @@ import { withPayload } from "payload-authjs";
 import { authConfig } from "./auth.config";
 
 export const { handlers, signIn, signOut, auth } = NextAuth(
-  withPayload(authConfig, {
+  withPayload(authConfig as any, {
     payloadConfig,
-    updateUserOnSignIn: true,
-  }),
+    events: {
+      /**
+       * Update user on every sign in
+       */
+      signIn: async ({ adapter, payload, user, profile }) => {
+        payload?.logger.info("signIn event");
+        if (!user.id || !profile) {
+          return;
+        }
+        await adapter.updateUser!({
+          id: user.id,
+          name: profile.name ?? (profile.login as string | undefined),
+          image: profile.avatar_url as string | undefined,
+          additionalUserDatabaseField: `Create by updateUserOnSignIn at ${new Date().toISOString()}`,
+        });
+      },
+    },
+  }) as any,
 );

packages/payload-authjs/README.md

@@ -177,7 +177,7 @@ const authConfig: NextAuthConfig = {
 };
 ```
 
-⚠ Keep in mind that Auth.js doesn't update the user after the first sign-in.
+> ⚠ Keep in mind that Auth.js doesn't update the user after the first sign-in. If you want to update the user on every sign-in, you can use the `signIn` event. (See [Events](#events))
 
 ### 2. Virtual fields (jwt session only)
 
@@ -251,6 +251,48 @@ const Examples: CollectionConfig = {
 
 </details>
 
+## 🎉 Events
+
+Auth.js emits some [events](https://authjs.dev/reference/nextjs#events) that you can listen to. This plugin extends the events with additional parameters like the `adapter` and `payload` instance.
+
+_More information about the events can be found in the [Auth.js documentation](https://authjs.dev/reference/nextjs#events)._
+
+The following events are available:
+
+- signIn
+- signOut
+- createUser
+- updateUser
+- linkAccount
+- session
+
+## `signIn` Event
+
+The `signIn` event is emitted when a user successfully signs in. For example, you could use this event to update the user's name on every sign-in:
+
+```ts
+// auth.ts
+export const { handlers, signIn, signOut, auth } = NextAuth(
+  withPayload(authConfig, {
+    payloadConfig,
+    events: {
+      /**
+       * Update user 'name' on every sign in
+       */
+      signIn: async ({ adapter, user, profile }) => {
+        if (!user.id || !profile) {
+          return;
+        }
+        await adapter.updateUser!({
+          id: user.id,
+          name: profile.name ?? (profile.login as string | undefined),
+        });
+      },
+    },
+  }),
+);
+```
+
 ## 📐 Utility functions
 
 This plugin also export a utility function to get the current payload user in the server-side:

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

@@ -1,13 +1,63 @@
 import type { NextAuthConfig } from "next-auth";
+import type { Adapter } from "next-auth/adapters";
+import type { Payload } from "payload";
+import { deepCopyObjectSimple, getPayload } from "payload";
 import { PayloadAdapter, type PayloadAdapterOptions } from "./PayloadAdapter";
 
+type CustomEvent<T extends keyof NonNullable<NextAuthConfig["events"]>> = (
+  message: {
+    /**
+     * The Auth.js database adapter
+     */
+    adapter: Adapter;
+    /**
+     * The payload instance
+     */
+    payload?: Payload;
+  } & Parameters<NonNullable<NonNullable<NextAuthConfig["events"]>[T]>>[0],
+) => void | PromiseLike<void>;
+
 export interface WithPayloadOptions extends PayloadAdapterOptions {
   /**
    * Update the user after every sign in
    *
+   * @deprecated updateUserOnSignIn is deprecated and will be removed in the future. Use events.signIn instead
+   *
    * @default false
    */
   updateUserOnSignIn?: boolean;
+  /**
+   * Auth.js events
+   * All events from authjs will be forwarded and enriched with additional parameters like the adapter and the payload instance
+   *
+   * @see https://authjs.dev/reference/nextjs#events
+   */
+  events?: {
+    /**
+     * Sign in event
+     */
+    signIn?: CustomEvent<"signIn">;
+    /**
+     * Sign out event
+     */
+    signOut?: CustomEvent<"signOut">;
+    /**
+     * Create user event
+     */
+    createUser?: CustomEvent<"createUser">;
+    /**
+     * Update user event
+     */
+    updateUser?: CustomEvent<"updateUser">;
+    /**
+     * Link account event
+     */
+    linkAccount?: CustomEvent<"linkAccount">;
+    /**
+     * Session event
+     */
+    session?: CustomEvent<"session">;
+  };
 }
 
 /**
@@ -22,7 +72,7 @@ export interface WithPayloadOptions extends PayloadAdapterOptions {
  */
 export function withPayload(
   authjsConfig: NextAuthConfig,
-  { updateUserOnSignIn, ...options }: WithPayloadOptions,
+  { updateUserOnSignIn, events, ...options }: WithPayloadOptions,
 ): NextAuthConfig {
   authjsConfig = { ...authjsConfig };
 
@@ -71,5 +121,32 @@ export function withPayload(
     };
   }
 
+  // Forward all events from authjs and enrich them with additional parameters
+  const originalEvents = deepCopyObjectSimple(authjsConfig.events ?? {});
+  authjsConfig.events = Object.entries(events ?? {}).reduce((result, [key, customEvent]) => {
+    const originalEvent = result[key as keyof typeof result];
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    result[key as keyof typeof result] = async (message: any) => {
+      // Call the original event
+      await originalEvent?.(message);
+
+      // Call the custom event
+      await customEvent?.({
+        ...message,
+        // Add the adapter to the event
+        adapter: authjsConfig.adapter!,
+        // Add payload to the event
+        payload: options.payload
+          ? await options.payload
+          : options.payloadConfig
+            ? await getPayload({ config: options.payloadConfig })
+            : undefined,
+      });
+    };
+
+    return result;
+  }, originalEvents);
+
   return authjsConfig;
 }