feat: add option donotExclude

Author: Innei

__tests__/exclude.test.ts

@@ -55,4 +55,32 @@ describe('Exclude() decorator', () => {
       },
     })
   })
+
+  it('do not omits Exclude()-decorated properties from output schema', () => {
+    const schema = validationMetadatasToSchemas({
+      classTransformerMetadataStorage: defaultMetadataStorage,
+      doNotExcludeDecorator: true,
+    })
+
+    expect(schema).toEqual({
+      Parent: {
+        properties: {
+          inherited: {},
+          inheritedInternal: {},
+        },
+        type: 'object',
+        required: ['inherited', 'inheritedInternal'],
+      },
+      User: {
+        properties: {
+          id: { type: 'string' },
+          inherited: {},
+          inheritedInternal: {},
+          internal: {},
+        },
+        type: 'object',
+        required: ['id', 'internal', 'inherited', 'inheritedInternal'],
+      },
+    })
+  })
 })

src/index.ts

@@ -52,15 +52,17 @@ export function validationMetadataArrayToSchemas(
     )
   ).forEach(([key, ownMetas]) => {
     const target = ownMetas[0].target as Function
-    const metas = ownMetas
-      .concat(getInheritedMetadatas(target, metadatas))
-      .filter(
+
+    let metas = ownMetas.concat(getInheritedMetadatas(target, metadatas))
+    if (!options.doNotExcludeDecorator) {
+      metas = metas.filter(
         (propMeta) =>
           !(
             isExcluded(propMeta, options) ||
             isExcluded({ ...propMeta, target }, options)
           )
       )
+    }
 
     const properties: { [name: string]: SchemaObject } = {}
 

src/options.ts

@@ -40,11 +40,18 @@ export interface IOptions extends ValidatorOptions {
    * Defaults to `name`, i.e., class name.
    */
   schemaNameField: string
+
+  /**
+   * Do not exclude field which decorate with `Exclude` decorator.
+   * Defaults to `false`
+   */
+  doNotExcludeDecorator: boolean
 }
 
 export const defaultOptions: IOptions = {
   additionalConverters: {},
   classValidatorMetadataStorage: getMetadataStorage(),
   refPointerPrefix: '#/definitions/',
   schemaNameField: 'name',
+  doNotExcludeDecorator: false,
 }