fix(sdk): correct return types with select (#15289)

Fixes #15279

Author: r1tsuu

packages/sdk/src/collections/delete.ts

@@ -11,7 +11,7 @@ import type {
 export type DeleteBaseOptions<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
-  TSelect extends SelectType,
+  TSelect extends SelectFromCollectionSlug<T, TSlug>,
 > = {
   /**
    * the Collection slug to operate against.

packages/sdk/src/collections/find.ts

@@ -9,12 +9,17 @@ import type {
 } from 'payload'
 
 import type { PayloadSDK } from '../index.js'
-import type { JoinQuery, PopulateType, TransformCollectionWithSelect } from '../types.js'
+import type {
+  JoinQuery,
+  PopulateType,
+  SelectFromCollectionSlug,
+  TransformCollectionWithSelect,
+} from '../types.js'
 
 export type FindOptions<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
-  TSelect extends SelectType,
+  TSelect extends SelectFromCollectionSlug<T, TSlug>,
 > = {
   /**
    * the Collection slug to operate against.
@@ -89,7 +94,7 @@ export type FindOptions<
 export async function find<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
-  TSelect extends SelectType,
+  TSelect extends SelectFromCollectionSlug<T, TSlug>,
 >(
   sdk: PayloadSDK<T>,
   options: FindOptions<T, TSlug, TSelect>,

packages/sdk/src/collections/findByID.ts

@@ -1,19 +1,18 @@
-import type {
-  ApplyDisableErrors,
-  CollectionSlug,
-  PayloadTypesShape,
-  SelectType,
-  TypedLocale,
-} from 'payload'
+import type { ApplyDisableErrors, CollectionSlug, PayloadTypesShape, TypedLocale } from 'payload'
 
 import type { PayloadSDK } from '../index.js'
-import type { JoinQuery, PopulateType, TransformCollectionWithSelect } from '../types.js'
+import type {
+  JoinQuery,
+  PopulateType,
+  SelectFromCollectionSlug,
+  TransformCollectionWithSelect,
+} from '../types.js'
 
 export type FindByIDOptions<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
   TDisableErrors extends boolean,
-  TSelect extends SelectType,
+  TSelect extends SelectFromCollectionSlug<T, TSlug>,
 > = {
   /**
    * the Collection slug to operate against.
@@ -63,7 +62,7 @@ export async function findByID<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
   TDisableErrors extends boolean,
-  TSelect extends SelectType,
+  TSelect extends SelectFromCollectionSlug<T, TSlug>,
 >(
   sdk: PayloadSDK<T>,
   options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>,

packages/sdk/src/collections/update.ts

@@ -22,7 +22,7 @@ import { resolveFileFromOptions } from '../utilities/resolveFileFromOptions.js'
 export type UpdateBaseOptions<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
-  TSelect extends SelectType,
+  TSelect extends SelectFromCollectionSlug<T, TSlug>,
 > = {
   /**
    * Whether the current update should be marked as from autosave.

packages/sdk/src/globals/update.ts

@@ -1,4 +1,4 @@
-import type { GlobalSlug, PayloadTypesShape, SelectType, TypedLocale } from 'payload'
+import type { GlobalSlug, PayloadTypesShape, TypedLocale } from 'payload'
 import type { DeepPartial } from 'ts-essentials'
 
 import type { PayloadSDK } from '../index.js'
@@ -12,7 +12,7 @@ import type {
 export type UpdateGlobalOptions<
   T extends PayloadTypesShape,
   TSlug extends GlobalSlug<T>,
-  TSelect extends SelectType,
+  TSelect extends SelectFromGlobalSlug<T, TSlug>,
 > = {
   /**
    * The global data to update.

packages/sdk/src/index.ts

@@ -196,7 +196,7 @@ export class PayloadSDK<T extends PayloadTypesShape = PayloadTypes> {
    * @param options
    * @returns documents satisfying query
    */
-  find<TSlug extends CollectionSlug<T>, TSelect extends SelectType>(
+  find<TSlug extends CollectionSlug<T>, TSelect extends SelectFromCollectionSlug<T, TSlug>>(
     options: FindOptions<T, TSlug, TSelect>,
     init?: RequestInit,
   ): Promise<PaginatedDocs<TransformCollectionWithSelect<T, TSlug, TSelect>>> {
@@ -211,7 +211,7 @@ export class PayloadSDK<T extends PayloadTypesShape = PayloadTypes> {
   findByID<
     TSlug extends CollectionSlug<T>,
     TDisableErrors extends boolean,
-    TSelect extends SelectType,
+    TSelect extends SelectFromCollectionSlug<T, TSlug>,
   >(
     options: FindByIDOptions<T, TSlug, TDisableErrors, TSelect>,
     init?: RequestInit,

packages/sdk/src/types.ts

@@ -7,6 +7,7 @@ import type {
   SelectType,
   Sort,
   TransformDataWithSelect,
+  TypedCollectionSelect,
   TypeWithID,
   Where,
 } from 'payload'
@@ -33,27 +34,35 @@ export type DataFromGlobalSlug<
 export type SelectFromCollectionSlug<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
-> = SelectType & T['collectionsSelect'][TSlug]
+> = TSlug extends keyof T['collectionsSelect'] ? T['collectionsSelect'][TSlug] : SelectType
 
 export type SelectFromGlobalSlug<
   T extends PayloadTypesShape,
   TSlug extends GlobalSlug<T>,
-> = SelectType & T['globalsSelect'][TSlug]
+> = TSlug extends keyof T['globalsSelect'] ? T['globalsSelect'][TSlug] : SelectType
 
 export type TransformCollectionWithSelect<
   T extends PayloadTypesShape,
   TSlug extends CollectionSlug<T>,
   TSelect,
 > = TSelect extends SelectType
-  ? TransformDataWithSelect<(JsonObject & TypeWithID) & T['collections'][TSlug], TSelect>
+  ? TransformDataWithSelect<
+      T['collections'][TSlug] extends JsonObject
+        ? T['collections'][TSlug]
+        : JsonObject & TypeWithID,
+      TSelect
+    >
   : T['collections'][TSlug]
 
 export type TransformGlobalWithSelect<
   T extends PayloadTypesShape,
   TSlug extends GlobalSlug<T>,
   TSelect,
 > = TSelect extends SelectType
-  ? TransformDataWithSelect<JsonObject & T['globals'][TSlug], TSelect>
+  ? TransformDataWithSelect<
+      T['globals'][TSlug] extends JsonObject ? T['globals'][TSlug] : JsonObject & TypeWithID,
+      TSelect
+    >
   : T['globals'][TSlug]
 
 type SystemFields = 'createdAt' | 'id' | 'sizes' | 'updatedAt'

test/types/types.spec.ts

@@ -963,7 +963,7 @@ describe('Types testing', () => {
           radioField: 'option-1',
         },
       })
-      expect(result).type.toBe<JsonObject & LocalConfig['collections']['posts'] & TypeWithID>()
+      expect(result).type.toBe<LocalConfig['collections']['posts']>()
     })
 
     test('SDK create data should be typed and reject invalid properties', () => {
@@ -983,6 +983,26 @@ describe('Types testing', () => {
         }),
       ).type.toRaiseError()
     })
+
+    test('SDK with select in findByID returns correct types', async () => {
+      const _sdk = new PayloadSDK<LocalConfig>({ baseURL: '' })
+      const result = await _sdk.findByID({
+        collection: 'posts',
+        id: 'id',
+        select: { title: true, namedGroup: true },
+      })
+      expect(result).type.toBe<Pick<Post, 'id' | 'namedGroup' | 'title'>>()
+    })
+
+    test('SDK with select excluding field in findByID returns correct types', async () => {
+      const _sdk = new PayloadSDK<LocalConfig>({ baseURL: '' })
+      const result = await _sdk.findByID({
+        collection: 'posts',
+        id: 'id',
+        select: { richText: false },
+      })
+      expect(result).type.toBe<Omit<Post, 'richText'>>()
+    })
   })
 
   describe('strictDraftTypes flag', () => {