fix: Fix types of getPayloadUser

Author: CrawlerCode

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

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

src/PayloadAdapter.ts

@@ -5,7 +5,7 @@ import {
   AdapterUser,
   VerificationToken as AdapterVerificationToken,
 } from "next-auth/adapters";
-import { Payload, SanitizedConfig } from "payload";
+import { CollectionSlug, Payload, SanitizedConfig } from "payload";
 import { Session, User, VerificationToken } from "./types";
 
 export interface PayloadAdapterOptions {
@@ -25,7 +25,7 @@ export interface PayloadAdapterOptions {
    *
    * @default "users"
    */
-  userCollectionSlug?: string;
+  userCollectionSlug?: CollectionSlug;
 }
 /**
  * Auth.js Database Adapter for Payload CMS

src/getPayloadUser.ts

@@ -1,30 +1,44 @@
 import { cookies } from "next/headers";
-import { CollectionSlug, DataFromCollectionSlug } from "payload";
+import { CollectionSlug } from "payload";
+import { User } from "./types";
 
-type Options<TSlug extends CollectionSlug> = {
+type Options = {
+  /**
+   * The URL of the server
+   *
+   * @default process.env.NEXT_PUBLIC_SERVER_URL
+   */
+  serverUrl?: string;
   /**
    * The slug of the collection that contains the users
    *
    * @default "users"
    */
-  userCollectionSlug?: TSlug;
+  userCollectionSlug?: CollectionSlug;
 };
 
-export const getPayloadUser = async <TSlug extends CollectionSlug = "users">({
-  userCollectionSlug = "users" as TSlug,
-}: Options<TSlug> = {}) => {
+/**
+ * Get the user payload from the server (only works on the server side)
+ */
+export const getPayloadUser = async <T extends object = User>({
+  serverUrl = process.env.NEXT_PUBLIC_SERVER_URL,
+  userCollectionSlug = "users",
+}: Options = {}) => {
+  if (serverUrl === undefined) {
+    throw new Error(
+      "getPayloadUser requires a server URL to be provided, either as an option or in the 'NEXT_PUBLIC_SERVER_URL' environment variable",
+    );
+  }
+
   const cookieStore = cookies();
 
-  const meUserReq = await fetch(
-    `${process.env.NEXT_PUBLIC_SERVER_URL}/api/${userCollectionSlug}/me`,
-    {
-      headers: {
-        Cookie: cookieStore.toString(),
-      },
+  const meUserReq = await fetch(`${serverUrl}/api/${userCollectionSlug}/me`, {
+    headers: {
+      Cookie: cookieStore.toString(),
     },
-  );
+  });
 
-  const { user }: { user: DataFromCollectionSlug<TSlug> } = await meUserReq.json();
+  const { user }: { user: T } = await meUserReq.json();
 
   if (!meUserReq.ok || !user) return;