Add wrap mode to resolvers-composition transform (#1928)

* Implement "wrap" mode on resolvers composition transform

so this works on GraphQL sources as well

* Update documentation

Author: santino

.changeset/young-yaks-prove.md

@@ -0,0 +1,6 @@
+---
+'@graphql-mesh/transform-resolvers-composition': minor
+'@graphql-mesh/types': minor
+---
+
+Add wrap mode to resolvers-composition transform (#1928)

packages/transforms/resolvers-composition/src/index.ts

@@ -5,19 +5,20 @@ import { composeResolvers, ResolversComposerMapping } from '@graphql-tools/resol
 import { extractResolvers, loadFromModuleExportExpressionSync } from '@graphql-mesh/utils';
 
 export default class ResolversCompositionTransform implements MeshTransform {
-  public noWrap = true;
-  private config: YamlConfig.Transform['resolversComposition'];
+  public noWrap: boolean;
+  private compositions: YamlConfig.ResolversCompositionTransform['compositions'];
   private baseDir: string;
 
   constructor({ baseDir, config }: MeshTransformOptions<YamlConfig.Transform['resolversComposition']>) {
-    this.config = config;
+    this.noWrap = config.mode ? config.mode !== 'wrap' : false; // use config.mode value or default to false
+    this.compositions = Array.isArray(config) ? config : config.compositions;
     this.baseDir = baseDir;
   }
 
   transformSchema(schema: GraphQLSchema) {
     const resolversComposition: ResolversComposerMapping = {};
 
-    for (const { resolver, composer } of this.config) {
+    for (const { resolver, composer } of this.compositions) {
       resolversComposition[resolver] = loadFromModuleExportExpressionSync(composer, {
         defaultExportName: 'default',
         cwd: this.baseDir,

packages/transforms/resolvers-composition/yaml-config.graphql

@@ -2,10 +2,23 @@ extend type Transform {
   """
   Transformer to apply composition to resolvers
   """
-  resolversComposition: [ResolversCompositionTransformObject!]
+  resolversComposition: ResolversCompositionTransformConfig
 }
 
-type ResolversCompositionTransformObject @md {
+union ResolversCompositionTransformConfig = ResolversCompositionTransform | Any
+
+type ResolversCompositionTransform @md {
+  """
+  Specify to apply resolvers-composition transforms to bare schema or by wrapping original schema
+  """
+  mode: ResolversCompositionTransformMode
+  """
+  Array of resolver/composer to apply
+  """
+  compositions: [ResolversCompositionTransformObject!]!
+}
+
+type ResolversCompositionTransformObject {
   """
   The GraphQL Resolver path
   Example: Query.users
@@ -17,3 +30,8 @@ type ResolversCompositionTransformObject @md {
   """
   composer: Any!
 }
+
+enum ResolversCompositionTransformMode {
+  bare
+  wrap
+}

packages/types/src/config-schema.json

@@ -410,12 +410,27 @@
           ]
         },
         "resolversComposition": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/ResolversCompositionTransformObject"
-          },
-          "additionalItems": false,
-          "description": "Transformer to apply composition to resolvers"
+          "description": "Transformer to apply composition to resolvers (Any of: ResolversCompositionTransform, Any)",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ResolversCompositionTransform"
+            },
+            {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": true
+                },
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "additionalItems": true
+                }
+              ]
+            }
+          ]
         },
         "snapshot": {
           "$ref": "#/definitions/SnapshotTransformConfig",
@@ -2233,6 +2248,27 @@
         }
       }
     },
+    "ResolversCompositionTransform": {
+      "additionalProperties": false,
+      "type": "object",
+      "title": "ResolversCompositionTransform",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": ["bare", "wrap"],
+          "description": "Specify to apply resolvers-composition transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)"
+        },
+        "compositions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ResolversCompositionTransformObject"
+          },
+          "additionalItems": false,
+          "description": "Array of resolver/composer to apply"
+        }
+      },
+      "required": ["compositions"]
+    },
     "ResolversCompositionTransformObject": {
       "additionalProperties": false,
       "type": "object",

packages/types/src/config.ts

@@ -891,9 +891,9 @@ export interface Transform {
    */
   rename?: RenameTransform | any;
   /**
-   * Transformer to apply composition to resolvers
+   * Transformer to apply composition to resolvers (Any of: ResolversCompositionTransform, Any)
    */
-  resolversComposition?: ResolversCompositionTransformObject[];
+  resolversComposition?: ResolversCompositionTransform | any;
   snapshot?: SnapshotTransformConfig;
   [k: string]: any;
 }
@@ -1161,6 +1161,16 @@ export interface RenameConfig1 {
   type?: string;
   field?: string;
 }
+export interface ResolversCompositionTransform {
+  /**
+   * Specify to apply resolvers-composition transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)
+   */
+  mode?: 'bare' | 'wrap';
+  /**
+   * Array of resolver/composer to apply
+   */
+  compositions: ResolversCompositionTransformObject[];
+}
 export interface ResolversCompositionTransformObject {
   /**
    * The GraphQL Resolver path

patches/@changesets+cli+2.14.1.patch renamed to patches/@changesets+cli+2.16.0.patch

@@ -1,8 +1,8 @@
 diff --git a/node_modules/@changesets/cli/dist/cli.cjs.dev.js b/node_modules/@changesets/cli/dist/cli.cjs.dev.js
-index f2a2bfc..0e0b3ff 100644
+index f771824..bcb14cc 100644
 --- a/node_modules/@changesets/cli/dist/cli.cjs.dev.js
 +++ b/node_modules/@changesets/cli/dist/cli.cjs.dev.js
-@@ -556,8 +556,8 @@ async function version(cwd, options, config) {
+@@ -576,8 +576,8 @@ async function version(cwd, options, config) {
  // @ts-ignore
  var isCI = !!(isCI__default['default'] || process.env.GITHUB_ACTIONS);
 
@@ -14,10 +14,10 @@ index f2a2bfc..0e0b3ff 100644
  function jsonParse(input) {
    try {
 diff --git a/node_modules/@changesets/cli/dist/cli.esm.js b/node_modules/@changesets/cli/dist/cli.esm.js
-index 82f2141..d320958 100644
+index 40bcc31..258c15a 100644
 --- a/node_modules/@changesets/cli/dist/cli.esm.js
 +++ b/node_modules/@changesets/cli/dist/cli.esm.js
-@@ -533,8 +533,8 @@ async function version(cwd, options, config) {
+@@ -553,8 +553,8 @@ async function version(cwd, options, config) {
  // @ts-ignore
  var isCI = !!(isCI$1 || process.env.GITHUB_ACTIONS);
 

patches/@docusaurus+theme-search-algolia+2.0.0-alpha.72.patch renamed to patches/@docusaurus+theme-search-algolia+2.0.0-alpha.ffe8b6106.patch

@@ -32,4 +32,4 @@ index 033a105..a4148d8 100644
 +
        return searchClient;
      },
-     [siteMetadata.docusaurusVersion],
+     [siteMetadata.docusaurusVersion],

website/docs/getting-started/mesh-transforms.md

@@ -186,17 +186,21 @@ transforms:
             field: code
 ```
 
-### Transforms supporting "bare" mode
+### Modes support
 
-Being a recent addition, "bare" mode is not available to all transforms yet.  
-The table below gives you the list of transforms that support "bare" mode. Transforms not listed here do not support "bare", and so only implement default "wrap" mode.  
-If you have use cases where you believe "bare" mode should be added to a transform not listed here, feel free to [open a feature request](https://github.com/Urigo/graphql-mesh/issues/new/choose).
+The table below illustrates how "bare" and "wrap" modes are supported across all transforms.  
+If you have use cases for which you would require to introduce either "bare" or "wrap" mode to one of the transforms, feel free to [open a feature request](https://github.com/Urigo/graphql-mesh/issues/new/choose).
 
 | Transform             | Bare | Wrap |                      Docs                      |
 | --------------------- | :--: | :--: | :--------------------------------------------: |
 | Cache                 |  ✅  |  ❌  | [docs](/docs/transforms/cache)                 |
+| Encapsulate           |  ❌  |  ✅  | [docs](/docs/transforms/encapsulate)           |
 | Extend                |  ✅  |  ❌  | [docs](/docs/transforms/extend)                |
+| Federation            |  ❌  |  ✅  | [docs](/docs/transforms/federation)            |
 | Filter Schema         |  ✅  |  ✅  | [docs](/docs/transforms/filter-schema)         |
+| Mock                  |  ❌  |  ✅  | [docs](/docs/transforms/mock)                  |
+| Naming Convention     |  ❌  |  ✅  | [docs](/docs/transforms/naming-convention)     |
+| Prefix                |  ❌  |  ✅  | [docs](/docs/transforms/prefix)                |
 | Rename                |  ✅  |  ✅  | [docs](/docs/transforms/rename)                |
-| Resolvers Composition |  ✅  |  ❌  | [docs](/docs/transforms/resolvers-composition) |
+| Resolvers Composition |  ✅  |  ✅  | [docs](/docs/transforms/resolvers-composition) |
 | Snapshot              |  ✅  |  ❌  | [docs](/docs/transforms/snapshot)              |

website/docs/transforms/resolvers-composition.md

@@ -17,6 +17,8 @@ Add the following configuration to your Mesh config file:
 ```yml
 transforms:
   - resolversComposition:
+      mode: bare | wrap
+      compositions:
         - resolver: 'Query.me'
           composer: is-auth#isAuth
         - resolver: 'Mutation.*'
@@ -35,6 +37,7 @@ module.exports = {
 };
 ```
 
+> For information about "bare" and "wrap" modes, please read the [dedicated section](/docs/getting-started/mesh-transforms#two-different-modes).
 
 <iframe
      src="https://codesandbox.io/embed/github/Urigo/graphql-mesh/tree/master/examples/openapi-youtrack?fontsize=14&hidenavigation=1&theme=dark&module=%2F.meshrc.yml"