feat!: various type improvements (#6385)

**BREAKING:**
- Type narrowing for `relationTo` props on filterOptions, relationship
fields and upload fields
- Type narrowing for arguments of lexical relationship, link and upload
features
This commit is contained in:
Alessio Gravili
2024-06-24 16:38:46 -04:00
committed by GitHub
parent 3a0ca12881
commit ccbaee43cc
81 changed files with 871 additions and 709 deletions

View File

@@ -1,10 +1,8 @@
import type { CollectionAfterOperationHook, CollectionConfig } from 'payload'
import { AfterOperation } from '../../payload-types.js'
import type { CollectionConfig } from 'payload'
export const afterOperationSlug = 'afterOperation'
const AfterOperation: CollectionConfig = {
export const AfterOperationCollection: CollectionConfig = {
slug: afterOperationSlug,
hooks: {
// beforeRead: [(operation) => operation.doc],
@@ -25,8 +23,8 @@ const AfterOperation: CollectionConfig = {
}
if (operation === 'find') {
// only modify the first doc for `find` operations
// this is so we can test against the other operations
// Only modify the first doc for `find` operations.
// This is so that we can test against the other operations
return {
...result,
docs: result.docs?.map((doc, index) =>
@@ -62,7 +60,7 @@ const AfterOperation: CollectionConfig = {
return result
},
] as CollectionAfterOperationHook<AfterOperation>[],
],
},
fields: [
{
@@ -72,5 +70,3 @@ const AfterOperation: CollectionConfig = {
},
],
}
export default AfterOperation

View File

@@ -7,7 +7,7 @@ import type { SanitizedConfig } from 'payload'
import { APIError } from 'payload'
import { buildConfigWithDefaults } from '../buildConfigWithDefaults.js'
import AfterOperation from './collections/AfterOperation/index.js'
import { AfterOperationCollection } from './collections/AfterOperation/index.js'
import ChainingHooks from './collections/ChainingHooks/index.js'
import ContextHooks from './collections/ContextHooks/index.js'
import { DataHooks } from './collections/Data/index.js'
@@ -19,7 +19,7 @@ import Users, { seedHooksUsers } from './collections/Users/index.js'
import { DataHooksGlobal } from './globals/Data/index.js'
export const HooksConfig: Promise<SanitizedConfig> = buildConfigWithDefaults({
collections: [
AfterOperation,
AfterOperationCollection,
ContextHooks,
TransformHooks,
Hooks,

View File

@@ -3,7 +3,6 @@ import type { Payload } from 'payload'
import { AuthenticationError } from 'payload'
import type { NextRESTClient } from '../helpers/NextRESTClient.js'
import type { NestedAfterReadHook } from './payload-types.js'
import { devUser, regularUser } from '../credentials.js'
import { initPayloadInt } from '../helpers/initPayloadInt.js'