fix(getPayloadUser): Improved type

Author: CrawlerCode

README.md

@@ -137,15 +137,13 @@ This plugin also export a utility function to get the current payload user
 ```tsx
 // ServerComponentExample.tsx
 const ServerComponentExample = async () => {
-  const payloadUser = await getPayloadUser<DataFromCollectionSlug<"users">>();
+  const payloadUser = await getPayloadUser();
 
   return (
     <div>
       <h3>Payload CMS User</h3>
-      <div>
-        {JSON.stringify(payloadUser)}
-      </div>
+      <div>{JSON.stringify(payloadUser)}</div>
     </div>
   );
 };
-```
+```

dev/src/app/(app)/_components/AuthOverview.tsx

@@ -1,13 +1,12 @@
 import { auth } from "@/auth";
-import type { DataFromCollectionSlug } from "payload";
 import { getPayloadUser } from "payload-authjs";
 import { SignInButton } from "./SignInButton";
 import { SignOutButtonAuthjs } from "./SignOutButtonAuthjs";
 import { SignOutButtonPayload } from "./SignOutButtonPayload";
 
 const AuthOverview = async () => {
   const session = await auth();
-  const payloadUser = await getPayloadUser<DataFromCollectionSlug<"users">>();
+  const payloadUser = await getPayloadUser();
 
   return (
     <div>

dev/src/app/(app)/_components/SignOutButtonPayload.tsx

@@ -1,9 +1,11 @@
 "use client";
 
+import type { CollectionSlug } from "payload";
+
 export function SignOutButtonPayload({
   userCollectionSlug = "users",
 }: {
-  userCollectionSlug?: string;
+  userCollectionSlug?: CollectionSlug;
 }) {
   return (
     <button

src/payload/getPayloadUser.ts

@@ -1,8 +1,7 @@
 import { cookies } from "next/headers";
-import type { CollectionSlug } from "payload";
-import type { User } from "./types";
+import type { CollectionSlug, DataFromCollectionSlug } from "payload";
 
-interface Options {
+interface Options<TSlug extends CollectionSlug> {
   /**
    * The URL of the server
    *
@@ -14,16 +13,16 @@ interface Options {
    *
    * @default "users"
    */
-  userCollectionSlug?: CollectionSlug;
+  userCollectionSlug?: TSlug;
 }
 
 /**
- * Get the user payload from the server (only works on the server side)
+ * Get the payload user from the server (only works on the server side)
  */
-export const getPayloadUser = async <T extends object = User>({
+export const getPayloadUser = async <TSlug extends CollectionSlug = "users">({
   serverUrl = process.env.NEXT_PUBLIC_SERVER_URL,
-  userCollectionSlug = "users",
-}: Options = {}): Promise<T | null> => {
+  userCollectionSlug = "users" as TSlug,
+}: Options<TSlug> = {}): Promise<DataFromCollectionSlug<TSlug> | null> => {
   const requestCookies = await cookies();
 
   if (serverUrl === undefined) {
@@ -38,7 +37,7 @@ export const getPayloadUser = async <T extends object = User>({
     },
   });
 
-  const { user }: { user: T } = await meUserReq.json();
+  const { user }: { user: DataFromCollectionSlug<TSlug> } = await meUserReq.json();
 
   if (!meUserReq.ok || !user) {
     return null;