perf!: remove DeepRequired from sanitized collection types - #17541
Open
AlessioGr wants to merge 4 commits into
Open
perf!: remove DeepRequired from sanitized collection types#17541AlessioGr wants to merge 4 commits into
AlessioGr wants to merge 4 commits into
Conversation
AlessioGr
enabled auto-merge (squash)
July 29, 2026 18:36
AlessioGr
commented
Jul 29, 2026
| export const executeAccess = async ( | ||
| { id, data, disableErrors, isReadingStaticFile = false, req }: OperationArgs, | ||
| access: Access, | ||
| access?: Access, |
Member
Author
There was a problem hiding this comment.
Not all access fns are required, e.g. readVersions. So this is more accurate
AlessioGr
commented
Jul 29, 2026
| requireUsername?: boolean | ||
| } | ||
|
|
||
| type AuthCookies = { |
Member
Author
There was a problem hiding this comment.
Just extracting it out so we dont have to do NonNullable<IncomingAuthType['cookies']>
Member
There was a problem hiding this comment.
Any benefit in exporting these?
AlessioGr
commented
Jul 29, 2026
| beforeValidate: hooks?.beforeValidate ?? [], | ||
| me: hooks?.me ?? [], | ||
| refresh: hooks?.refresh ?? [], | ||
| } satisfies SanitizedCollectionConfig['hooks'] |
Member
Author
There was a problem hiding this comment.
By using satisfies, we get proper errors if this does not match the sanitized types. If we had that before, we would have caught the type <=> runtime mismatch
AlessioGr
commented
Jul 29, 2026
| // disable duplicate for auth enabled collections by default | ||
| sanitized.disableDuplicate = sanitized.disableDuplicate ?? true | ||
|
|
||
| if (sanitized.auth.loginWithUsername) { |
Member
Author
There was a problem hiding this comment.
Moved into defaults.ts
Contributor
📦 esbuild Bundle Analysis for payloadThis analysis was generated by esbuild-bundle-analyzer. 🤖
Largest pathsThese visualization shows top 20 largest paths in the bundle.Meta file: packages/next/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_index.json, Out file: esbuild/index.js
Meta file: packages/payload/meta_shared.json, Out file: esbuild/exports/shared.js
Meta file: packages/richtext-lexical/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_client.json, Out file: esbuild/exports/client_optimized/index.js
Meta file: packages/ui/meta_shared.json, Out file: esbuild/exports/shared_optimized/index.js
DetailsNext to the size is how much the size has increased or decreased compared with the base branch of this PR.
|
denolfe
reviewed
Jul 29, 2026
| }: { | ||
| deletedAtPath?: string | ||
| enableTrash: boolean | ||
| enableTrash?: boolean |
Member
Author
There was a problem hiding this comment.
Yep, trash became optional, which matches runtime behavior
Comment on lines
+819
to
+822
| Required<Pick<CollectionConfig, 'admin' | 'custom' | 'indexes' | 'timestamps'>> { | ||
| _sanitized: true | ||
| access: Pick<CollectionAccess, 'admin' | 'readVersions'> & | ||
| Required<Pick<CollectionAccess, 'create' | 'delete' | 'read' | 'unlock' | 'update'>> |
Member
There was a problem hiding this comment.
Are these individual props worth extracting out into their own types to make it more explicit what is happening here?
Member
Author
There was a problem hiding this comment.
I thought about that. They were extracted out, but I felt they are simple enough to inline. Less types you have to know
| requireUsername?: boolean | ||
| } | ||
|
|
||
| type AuthCookies = { |
Member
There was a problem hiding this comment.
Any benefit in exporting these?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR removes
DeepRequiredfromSanitizedCollectionConfigand its auth type. It uses shallowPick,Omit, andRequiredtypes so only properties populated during sanitization are required.Why
DeepRequiredrecursively processes large field, hook, admin, and conditional types, adding unnecessary TypeScript checker work.It was also inaccurate.
access.readVersions,auth.cookies.domain,auth.useAPIKey, andauth.depthcould be undefined but were typed as required. Meanwhile,auth.forgotPassword,auth.verify, and normalized username-login options were typed as optional despite always being populated.Breaking change
Code using
SanitizedCollectionConfigmay now need to handleundefinedfor properties Payload does not default.