feat(sdk): add logout helper and SDK method

packages/sdk/src/auth/logout.ts

@@ -0,0 +1,34 @@
+import type { PayloadSDK } from '../index.js'
+import type {
+  AuthCollectionSlug,
+  PayloadGeneratedTypes,
+} from '../types.js'
+
+export type LogoutOptions<
+  T extends PayloadGeneratedTypes,
+  TSlug extends AuthCollectionSlug<T>
+> = {
+  collection: TSlug
+  allSessions?: boolean
+}
+
+export type LogoutResult = {
+  message: string
+}
+
+export async function logout<
+  T extends PayloadGeneratedTypes,
+  TSlug extends AuthCollectionSlug<T>
+>(
+  sdk: PayloadSDK<T>,
+  options: LogoutOptions<T, TSlug>,
+  init?: RequestInit,
+): Promise<LogoutResult> {
+  const response = await sdk.request({
+    init,
+    method: 'POST',
+    path: `/${options.collection}/logout?allSessions=${options.allSessions ?? false}`,
+  })
+
+  return response.json()
+}

packages/sdk/src/index.ts

@@ -57,6 +57,7 @@ import { findGlobalVersions } from './globals/findVersions.js'
 import { restoreGlobalVersion } from './globals/restoreVersion.js'
 import { updateGlobal } from './globals/update.js'
 import { buildSearchParams } from './utilities/buildSearchParams.js'
+import { logout, LogoutOptions, LogoutResult } from './auth/logout.js'
 
 type Args = {
   /** Base passed `RequestInit` to `fetch`. For base headers / credentials include etc. */
@@ -371,4 +372,12 @@ export class PayloadSDK<T extends PayloadGeneratedTypes = PayloadGeneratedTypes>
   ): Promise<{ message: string }> {
     return verifyEmail(this, options, init)
   }
+
+  logout<TSlug extends AuthCollectionSlug<T>>(
+    options: LogoutOptions<T, TSlug>,
+    init?: RequestInit,
+  ): Promise<LogoutResult> {
+    return logout(this, options, init)
+  }
+
 }

test/sdk/int.spec.ts

@@ -306,4 +306,28 @@
 
     expect(email).toBe(user.email)
   })
+
+  it('should execute logout', async () => {
+    const loginRes = await sdk.login({
+      collection: 'users',
+      data: { email: testUserCredentials.email, password: testUserCredentials.password },
+    })
+
+    expect(loginRes.user.email).toBe(testUserCredentials.email)
+
+    const logoutRes = await sdk.logout({
+      collection: 'users',
+      allSessions: false,
+    })
+
+    expect(logoutRes.message).toBeDefined()
+
+    await expect(
+      sdk.request({
+        method: 'GET',
+        path: '/users/me',
+      }),
+    ).rejects.toThrow()
+  })
+
 })