Show GraphQL Yoga and move docs to Apollo Server v3 (#2217)

Author: kamilkisiela

.changeset/clean-rules-worry.md

@@ -0,0 +1,5 @@
+---
+'graphql-modules': patch
+---
+
+Add a deprecation note for createSchemaForApollo method

.changeset/config.json

@@ -11,6 +11,6 @@
     "examples-basic",
     "examples-di",
     "examples-subscriptions",
-    "example-graphql-ez"
+    "graphql-yoga"
   ]
 }

README.md

@@ -44,7 +44,7 @@ Just take a look at the build status on Github Actions and find "Publish Canary"
 More advanced usage at [graphql-modules.com](https://graphql-modules.com/docs)
 
 ```js
-import { createModule, createApplication, gql } from 'graphql-modules';
+import { createModule, createApplication, gql } from 'graphql-modules'
 
 const module = createModule({
   id: 'my-module',
@@ -59,12 +59,12 @@ const module = createModule({
       posts: [Post]
     }
   `,
-  resolvers: blogResolvers,
-});
+  resolvers: blogResolvers
+})
 
 const application = createApplication({
-  modules: [module],
-});
+  modules: [module]
+})
 ```
 
 Inside the `examples` directory you can find the following examples:

examples/ez/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "graphql-yoga",
+  "version": "0.0.0",
+  "private": true,
+  "main": "dist/index.js",
+  "license": "MIT",
+  "scripts": {
+    "start": "ts-node --project ../../tsconfig.app.json ./src/index.ts",
+    "build": "tsc"
+  }
+}

examples/ez/src/app/auth/auth.module.ts

@@ -0,0 +1,6 @@
+import { createApplication } from 'graphql-modules';
+import { PostModule } from './post/post.module';
+
+export const app = createApplication({
+  modules: [PostModule],
+});

examples/ez/src/app/social-network/social-network.module.ts

@@ -0,0 +1,51 @@
+import { createModule, gql } from 'graphql-modules';
+import { PostsProvider } from './post.provider';
+import { PubSub, PUB_SUB, providePubSub } from './pubsub';
+
+export const PostModule = createModule({
+  id: 'post',
+  dirname: __dirname,
+  providers: [PostsProvider, providePubSub()],
+  typeDefs: gql`
+    type Subscription {
+      postAdded: Post
+    }
+
+    type Query {
+      posts: [Post]
+    }
+
+    type Mutation {
+      addPost(author: String, comment: String): Post
+    }
+
+    type Post {
+      author: String
+      comment: String
+    }
+  `,
+  resolvers: {
+    Subscription: {
+      postAdded: {
+        // Additional event labels can be passed to asyncIterator creation
+        subscribe(
+          _root: any,
+          _args: any,
+          { injector }: GraphQLModules.Context
+        ) {
+          return injector.get<PubSub>(PUB_SUB).subscribe('POST_ADDED');
+        },
+      },
+    },
+    Query: {
+      posts(_root: any, _args: any, { injector }: GraphQLModules.Context) {
+        return injector.get(PostsProvider).getPosts();
+      },
+    },
+    Mutation: {
+      addPost(_root: any, args: any, { injector }: GraphQLModules.Context) {
+        return injector.get(PostsProvider).addPost(args);
+      },
+    },
+  },
+});

examples/ez/src/app/user/user.module.ts

@@ -0,0 +1,20 @@
+import { Injectable, Inject } from 'graphql-modules';
+import { PUB_SUB, PubSub } from './pubsub';
+import { Post } from './types';
+
+@Injectable()
+export class PostsProvider {
+  posts: Post[] = [];
+
+  constructor(@Inject(PUB_SUB) private pubSub: PubSub) {}
+
+  getPosts() {
+    return this.posts;
+  }
+
+  addPost(post: Post) {
+    this.posts.push(post);
+    this.pubSub.publish('POST_ADDED', { postAdded: post });
+    return post;
+  }
+}

examples/ez/src/index.ts

@@ -0,0 +1,25 @@
+import { InjectionToken, FactoryProvider, Scope } from 'graphql-modules';
+import { createPubSub, PubSub as TPubSub } from '@graphql-yoga/node';
+import { Post } from './types';
+
+type PubSub = TPubSub<{
+  POST_ADDED: [
+    {
+      postAdded: Post;
+    }
+  ];
+}>;
+
+export const PUB_SUB = new InjectionToken<PubSub>('PubSub');
+
+export { PubSub };
+
+export function providePubSub(): FactoryProvider<PubSub> {
+  return {
+    provide: PUB_SUB,
+    scope: Scope.Singleton,
+    useFactory() {
+      return createPubSub();
+    },
+  };
+}

examples/graphql-yoga/package.json

@@ -0,0 +1,4 @@
+export interface Post {
+  author: string;
+  comment: string;
+}

examples/graphql-yoga/src/app/index.ts

@@ -0,0 +1,13 @@
+import 'reflect-metadata';
+import { createServer } from '@graphql-yoga/node';
+import { useGraphQLModules } from '@envelop/graphql-modules';
+import { app } from './app';
+
+const server = createServer({
+  plugins: [useGraphQLModules(app)],
+});
+
+server.start().then(() => {
+  // tslint:disable-next-line: no-console
+  console.info(`🚀 Server ready at http://localhost:4000/graphql`);
+});

examples/graphql-yoga/src/app/post/post.module.ts

@@ -32,7 +32,9 @@
     "@babel/plugin-proposal-class-properties": "7.17.12",
     "@changesets/apply-release-plan": "5.0.1",
     "@changesets/cli": "2.23.0",
+    "@envelop/graphql-modules": "3.3.3",
     "@graphql-tools/merge": "8.2.14",
+    "@graphql-yoga/node": "2.9.2",
     "@types/benchmark": "2.1.1",
     "@types/express": "4.17.13",
     "@types/jest": "27.5.2",