Skip to content

feat(common): allow injecting global serializer options - #16966

Open
Nosfistis wants to merge 1 commit into
nestjs:masterfrom
Nosfistis:bugfix/serializer-global-options
Open

feat(common): allow injecting global serializer options#16966
Nosfistis wants to merge 1 commit into
nestjs:masterfrom
Nosfistis:bugfix/serializer-global-options

Conversation

@Nosfistis

@Nosfistis Nosfistis commented May 18, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Issue Number: #16963

What is the new behavior?

It is now possible to use ClassSerializerInterceptorOptions to inject options for class-serializer interceptor globally.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@Nosfistis

Nosfistis commented May 18, 2026

Copy link
Copy Markdown
Contributor Author

Transforming ClassSerializerInterceptorOptions to class required a member implementation. In order to avoid that I would have to create a new string injection token.

@coveralls

coveralls commented May 18, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 31

Coverage remained the same at 89.903%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.

Coverage Stats

Coverage Status
Relevant Lines: 8567
Covered Lines: 7702
Line Coverage: 89.9%
Relevant Branches: 2925
Covered Branches: 2372
Branch Coverage: 81.09%
Branches in Coverage %: No
Coverage Strength: 56.5 hits per line
馃挍 - Coveralls

@kamilmysliwiec kamilmysliwiec mentioned this pull request May 18, 2026
Closed
1 task
@QusaiAlbonni

QusaiAlbonni commented May 18, 2026

Copy link
Copy Markdown
Contributor

Hi thanks for the PR @Nosfistis!
While I understand the point of this change
This could encourage a bad pattern of having settings anywhere in the dependency graph
Looking at the interceptor you'd have no way of knowing right away it's settings or tracing it you'd have to hunt down the place where the options were registered as a provider
Curious to know the maintainers thoughts about whether this is something tha fits in the direction nest is heading to or it's philosophy

@micalevisk

micalevisk commented May 18, 2026

Copy link
Copy Markdown
Member

btw this is not a 'fix' but a 'feat'

@Nosfistis

Nosfistis commented May 18, 2026

Copy link
Copy Markdown
Contributor Author

@micalevisk Indeed, it is a typo.

@Nosfistis Nosfistis changed the title fix(common): allow injecting global serializer options feat(common): allow injecting global serializer options May 25, 2026
@Nosfistis
Nosfistis force-pushed the bugfix/serializer-global-options branch from 1959b03 to 8933e9e Compare May 25, 2026 07:21
@Nosfistis

Nosfistis commented May 25, 2026

Copy link
Copy Markdown
Contributor Author

I have amended the commit message, if that was the blocking part. Unless the whole reasoning of this PR is out of scope, let's discuss what else is needed.

@micalevisk
micalevisk requested a lite review from Copilot August 10, 2026 21:24
Copilot AI reviewed Aug 10, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Enables global dependency-injection of ClassSerializerInterceptor default options by turning ClassSerializerInterceptorOptions into a runtime DI token (a class), addressing the limitation described in #16963.

Changes:

  • Replaced ClassSerializerInterceptorOptions from a type-only interface with a runtime-exported class to support DI.
  • Added ClassTransformOptions-compatible option properties onto ClassSerializerInterceptorOptions for consumer typing.

馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread packages/common/serializer/class-serializer.interceptor.ts
Comment on lines +27 to 40
export class ClassSerializerInterceptorOptions implements ClassTransformOptions {
transformerPackage?: TransformerPackage;
strategy?: 'excludeAll' | 'exposeAll';
groups?: string[];
version?: number;
excludePrefixes?: string[];
ignoreDecorators?: boolean;
targetMaps?: any[];
enableCircularCheck?: boolean;
enableImplicitConversion?: boolean;
excludeExtraneousValues?: boolean;
exposeDefaultValues?: boolean;
exposeUnsetFields?: boolean;
}
Comment thread packages/common/serializer/class-serializer.interceptor.ts
* @publicApi
*/
export interface ClassSerializerInterceptorOptions extends ClassTransformOptions {
export class ClassSerializerInterceptorOptions implements ClassTransformOptions {

@micalevisk micalevisk Aug 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Nosfistis can you do this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
+1 more reviewer
@micalevisk micalevisk micalevisk left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Nosfistis @coveralls @QusaiAlbonni @micalevisk