feat: Add PayloadAuthjsUser helper type for authjs module declaration

Author: CrawlerCode

packages/dev/src/auth.config.ts

@@ -5,12 +5,12 @@ import type { JWT } from "next-auth/jwt";
 import github from "next-auth/providers/github";
 import keycloak from "next-auth/providers/keycloak";
 import nodemailer from "next-auth/providers/nodemailer";
+import type { PayloadAuthjsUser } from "payload-authjs";
 import type { User as PayloadUser } from "payload/generated-types";
 
 declare module "next-auth" {
   // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-  interface User
-    extends Partial<Omit<PayloadUser, "accounts" | "sessions" | "verificationTokens">> {}
+  interface User extends PayloadAuthjsUser<PayloadUser> {}
 }
 declare module "next-auth/jwt" {
   // eslint-disable-next-line @typescript-eslint/no-empty-object-type
@@ -145,9 +145,4 @@ export const authConfig: NextAuthConfig = {
       return !!auth;
     },
   },
-  /* events: {
-    signIn: () => {
-      console.log("original events.signIn");
-    },
-  }, */
 };

packages/payload-authjs/README.md

@@ -251,7 +251,23 @@ const Examples: CollectionConfig = {
 
 </details>
 
-## 🎉 Events
+## 🟦 Typescript
+
+If you are using typescript you can declare your Auth.js user type as shown in the following example:
+
+```ts
+// auth.config.ts
+import type { PayloadAuthjsUser } from "payload-authjs";
+import type { User as PayloadUser } from "payload/generated-types";
+
+declare module "next-auth" {
+  interface User extends PayloadAuthjsUser<PayloadUser> {}
+}
+```
+
+_More information about typescript can be found in the [Auth.js documentation](https://authjs.dev/getting-started/typescript?framework=next-js)._
+
+### 🎉 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.
 
@@ -266,7 +282,7 @@ The following events are available:
 - linkAccount
 - session
 
-## `signIn` Event
+### `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:
 

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

@@ -0,0 +1,16 @@
+/**
+ * Helper type to extract the user type from the collection user type.
+ *
+ * @example
+ * import type { PayloadAuthjsUser } from "payload-authjs";
+ * import type { User as PayloadUser } from "payload/generated-types";
+ *
+ * declare module "next-auth" {
+ *   interface User extends PayloadAuthjsUser<PayloadUser> {}
+ * }
+ *
+ * @see https://authjs.dev/getting-started/typescript?framework=next-js#module-augmentation
+ */
+export type PayloadAuthjsUser<User> = Partial<
+  Omit<User, "accounts" | "sessions" | "verificationTokens">
+>;

packages/payload-authjs/src/index.ts

@@ -1,4 +1,5 @@
 export { PayloadAdapter } from "./authjs/PayloadAdapter";
+export { type PayloadAuthjsUser } from "./authjs/types";
 export { withPayload } from "./authjs/withPayload";
 export { getPayloadUser } from "./payload/getPayloadUser";
 export { authjsPlugin, type AuthjsPluginConfig } from "./payload/plugin";