feat(filter-transform): filter deprecated types or fields

ardatan · Dec 5, 2023 · d758afa · d758afa
1 parent b6fa1c6
commit d758afa
Show file tree

Hide file tree

Showing 6 changed files with 69 additions and 2 deletions.
diff --git a/.changeset/dry-baboons-rest.md b/.changeset/dry-baboons-rest.md
@@ -0,0 +1,6 @@
+---
+'@graphql-mesh/transform-filter-schema': patch
+'@graphql-mesh/types': patch
+---
+
+`filterDeprecatedFields` and `filterDeprecatedTypes` options
diff --git a/packages/transforms/filter-schema/src/wrapFilter.ts b/packages/transforms/filter-schema/src/wrapFilter.ts
@@ -19,7 +19,11 @@ import {
 
 export default class WrapFilter implements Transform {
   private transforms: Transform[] = [];
-  constructor({ config: { filters } }: { config: YamlConfig.FilterSchemaTransform }) {
+  constructor({
+    config: { filters, filterDeprecatedFields, filterDeprecatedTypes },
+  }: {
+    config: YamlConfig.FilterSchemaTransform;
+  }) {
     for (const filter of filters) {
       const [typeName, fieldNameOrGlob, argsGlob] = filter.split('.');
       const typeMatcher = new Minimatch(typeName);
@@ -108,6 +112,37 @@ export default class WrapFilter implements Transform {
         }),
       );
     }
+    if (filterDeprecatedFields) {
+      this.transforms.push(
+        new FilterRootFields((_, fieldName, fieldConfig) => {
+          return !fieldConfig.deprecationReason;
+        }),
+      );
+      this.transforms.push(
+        new FilterObjectFields((_, fieldName, fieldConfig) => {
+          return !fieldConfig.deprecationReason;
+        }),
+      );
+      this.transforms.push(
+        new FilterInputObjectFields((_, fieldName, fieldConfig) => {
+          return !fieldConfig.deprecationReason;
+        }),
+      );
+      this.transforms.push(
+        new FilterInterfaceFields((_, fieldName, fieldConfig) => {
+          return !fieldConfig.deprecationReason;
+        }),
+      );
+    }
+    if (filterDeprecatedTypes) {
+      this.transforms.push(
+        new FilterTypes(type => {
+          return !type.astNode?.directives?.some(
+            directive => directive.name.value === 'deprecated',
+          );
+        }),
+      );
+    }
   }
 
   transformSchema(

diff --git a/packages/transforms/filter-schema/yaml-config.graphql b/packages/transforms/filter-schema/yaml-config.graphql
@@ -16,6 +16,14 @@ type FilterSchemaTransform @md {
   Array of filter rules
   """
   filters: [String!]!
+  """
+  Filter deprecated types
+  """
+  filterDeprecatedTypes: Boolean
+  """
+  Filter deprecated fields
+  """
+  filterDeprecatedFields: Boolean
 }
 
 enum FilterSchemaTransformMode {

diff --git a/packages/types/src/config-schema.json b/packages/types/src/config-schema.json
@@ -3436,6 +3436,14 @@
           },
           "additionalItems": false,
           "description": "Array of filter rules"
+        },
+        "filterDeprecatedTypes": {
+          "type": "boolean",
+          "description": "Filter deprecated types"
+        },
+        "filterDeprecatedFields": {
+          "type": "boolean",
+          "description": "Filter deprecated fields"
         }
       },
       "required": ["filters"]

diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts
@@ -1242,6 +1242,14 @@ export interface FilterSchemaTransform {
    * Array of filter rules
    */
   filters: string[];
+  /**
+   * Filter deprecated types
+   */
+  filterDeprecatedTypes?: boolean;
+  /**
+   * Filter deprecated fields
+   */
+  filterDeprecatedFields?: boolean;
 }
 export interface HoistFieldTransformConfig {
   /**

diff --git a/website/src/generated-markdown/FilterSchemaTransform.generated.md b/website/src/generated-markdown/FilterSchemaTransform.generated.md
@@ -1,3 +1,5 @@
 
 * `mode` (type: `String (bare | wrap)`) - Specify to apply filter-schema transforms to bare schema or by wrapping original schema
-* `filters` (type: `Array of String`, required) - Array of filter rules
+* `filters` (type: `Array of String`, required) - Array of filter rules
+* `filterDeprecatedTypes` (type: `Boolean`) - Filter deprecated types
+* `filterDeprecatedFields` (type: `Boolean`) - Filter deprecated fields