Merge branch 'mattleff-deprecated-enum-values'

nestjs · Nov 10, 2020 · 9ae49f6 · 9ae49f6
2 parents cd2c727 + 316eece
commit 9ae49f6
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 6 deletions.
diff --git a/lib/schema-builder/factories/enum-definition.factory.ts b/lib/schema-builder/factories/enum-definition.factory.ts
@@ -18,8 +18,11 @@ export class EnumDefinitionFactory {
         name: metadata.name,
         description: metadata.description,
         values: Object.keys(enumValues).reduce((prevValue, key) => {
+          const valueMap = metadata.valuesMap[key];
           prevValue[key] = {
             value: enumValues[key],
+            description: valueMap?.description,
+            deprecationReason: valueMap?.deprecationReason,
           };
           return prevValue;
         }, {}),
@@ -28,7 +31,7 @@ export class EnumDefinitionFactory {
   }
 
   private getEnumValues(enumObject: Record<string, any>) {
-    const enumKeys = Object.keys(enumObject).filter(key =>
+    const enumKeys = Object.keys(enumObject).filter((key) =>
       isNaN(parseInt(key, 10)),
     );
     return enumKeys.reduce((prev, nextKey) => {

diff --git a/lib/schema-builder/metadata/enum.metadata.ts b/lib/schema-builder/metadata/enum.metadata.ts
@@ -1,5 +1,15 @@
-export interface EnumMetadata {
-  ref: object;
+export interface EnumMetadataValuesMapOptions {
+  deprecationReason?: string;
+  description?: string;
+}
+
+export type EnumMetadataValuesMap<T extends object> = Partial<
+  Record<keyof T, EnumMetadataValuesMapOptions>
+>;
+
+export interface EnumMetadata<T extends object = any> {
+  ref: T;
   name: string;
   description?: string;
+  valuesMap?: EnumMetadataValuesMap<T>;
 }
diff --git a/lib/type-factories/register-enum-type.factory.ts b/lib/type-factories/register-enum-type.factory.ts
@@ -5,13 +5,14 @@
  * To avoid numerous breaking changes, the public API is backward-compatible and may resemble "type-graphql".
  */
 
+import { EnumMetadataValuesMap } from '../schema-builder/metadata';
 import { LazyMetadataStorage } from '../schema-builder/storages/lazy-metadata.storage';
 import { TypeMetadataStorage } from '../schema-builder/storages/type-metadata.storage';
 
 /**
  * Interface defining options that can be passed to `registerEnumType` function.
  */
-export interface EnumOptions {
+export interface EnumOptions<T extends object = any> {
   /**
    * Name of the enum.
    */
@@ -20,6 +21,10 @@ export interface EnumOptions {
    * Description of the enum.
    */
   description?: string;
+  /**
+   * A map of options for the values of the enum.
+   */
+  valuesMap?: EnumMetadataValuesMap<T>;
 }
 
 /**
@@ -28,13 +33,14 @@ export interface EnumOptions {
  */
 export function registerEnumType<T extends object = any>(
   enumRef: T,
-  options: EnumOptions,
+  options: EnumOptions<T>,
 ) {
   LazyMetadataStorage.store(() =>
     TypeMetadataStorage.addEnumMetadata({
       ref: enumRef,
       name: options.name,
       description: options.description,
+      valuesMap: options.valuesMap || {},
     }),
   );
 }
diff --git a/tests/code-first/enums/direction.enum.ts b/tests/code-first/enums/direction.enum.ts
@@ -5,9 +5,18 @@ export enum Direction {
   Down = 'DOWN',
   Left = 'LEFT',
   Right = 'RIGHT',
+  Sideways = 'SIDEWAYS',
 }
 
 registerEnumType(Direction, {
   name: 'Direction', // this one is mandatory
   description: 'The basic directions', // this one is optional
+  valuesMap: {
+    Sideways: {
+      deprecationReason: 'Replaced with Left or Right',
+    },
+    Up: {
+      description: 'The primary direction',
+    },
+  },
 });
diff --git a/tests/e2e/code-first-schema.spec.ts b/tests/e2e/code-first-schema.spec.ts
@@ -119,7 +119,7 @@ describe('Code-first - schema factory', () => {
           enumValues: [
             {
               deprecationReason: null,
-              description: null,
+              description: 'The primary direction',
               isDeprecated: false,
               name: 'Up',
             },
@@ -141,6 +141,12 @@ describe('Code-first - schema factory', () => {
               isDeprecated: false,
               name: 'Right',
             },
+            {
+              deprecationReason: 'Replaced with Left or Right',
+              description: null,
+              isDeprecated: true,
+              name: 'Sideways',
+            },
           ],
         }),
       );

diff --git a/tests/utils/printed-schema.snapshot.ts b/tests/utils/printed-schema.snapshot.ts
@@ -72,10 +72,12 @@ type Query {
 
 """The basic directions"""
 enum Direction {
+  """The primary direction"""
   Up
   Down
   Left
   Right
+  Sideways @deprecated(reason: "Replaced with Left or Right")
 }
 
 """Search result description"""
@@ -118,6 +120,9 @@ enum Direction {
   Down
   Left
   Right
+  Sideways @deprecated(reason: "Replaced with Left or Right")
+
+  """The primary direction"""
   Up
 }