Simple Node with TypeScript example (#1774)

* ts example

* use yoga.fetch and micro TS example

Author: enisdenjo

examples/node-ts/__integration-tests__/node-ts.spec.ts

@@ -0,0 +1,30 @@
+import { yoga } from '../src/yoga'
+
+describe('node-ts example integration', () => {
+  it('should execute query', async () => {
+    const response = await yoga.fetch('/graphql?query={hello}')
+
+    expect(response.status).toBe(200)
+    expect(await response.text()).toMatchInlineSnapshot(
+      `"{"data":{"hello":"world"}}"`,
+    )
+  })
+
+  it('should have subscriptions disabled', async () => {
+    const response = await yoga.fetch(
+      '/graphql?query=subscription{greetings}',
+      {
+        headers: {
+          Accept: 'text/event-stream',
+        },
+      },
+    )
+
+    expect(response.status).toBe(400)
+    expect(await response.text()).toMatchInlineSnapshot(`
+      "data: {"errors":[{"message":"Subscriptions have been disabled"}]}
+
+      "
+    `)
+  })
+})

examples/node-ts/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "example-node-ts",
+  "private": true,
+  "version": "1.0.0",
+  "scripts": {
+    "start": "ts-node src/index.ts",
+    "check": "tsc --pretty --noEmit"
+  },
+  "dependencies": {
+    "graphql-yoga": "3.0.0-next.0",
+    "graphql": "16.6.0"
+  },
+  "devDependencies": {
+    "ts-node": "10.9.1",
+    "typescript": "4.8.3"
+  }
+}

examples/node-ts/src/index.ts

@@ -0,0 +1,5 @@
+import { createServer } from 'http'
+import { yoga } from './yoga'
+
+const server = createServer(yoga)
+server.listen(4000)

examples/node-ts/src/yoga.ts

@@ -0,0 +1,62 @@
+import { createYoga, Plugin, createSchema } from 'graphql-yoga'
+import { GraphQLError } from 'graphql'
+
+// available when handling requests, needs to be provided by the implementor
+type ServerContext = {}
+
+// available in GraphQL, during execution/subscription
+interface UserContext {
+  disableSubscription: boolean
+}
+
+export const yoga = createYoga<ServerContext, UserContext>({
+  context: {
+    disableSubscription: true,
+  },
+  schema: createSchema({
+    typeDefs: /* GraphQL */ `
+      type Query {
+        hello: String!
+      }
+      type Subscription {
+        greetings: String!
+      }
+    `,
+    resolvers: {
+      Query: {
+        hello: () => 'world',
+      },
+      Subscription: {
+        greetings: {
+          async *subscribe() {
+            yield { greetings: 'Hi' }
+          },
+        },
+      },
+    },
+  }),
+  plugins: [useDisableSubscription()],
+})
+
+// context only relevant to the plugin
+type DisableSubscriptionPluginContext = {}
+
+function useDisableSubscription(): Plugin<
+  DisableSubscriptionPluginContext,
+  ServerContext,
+  UserContext
+> {
+  return {
+    onSubscribe({ args }) {
+      if (args.contextValue.disableSubscription) {
+        throw new GraphQLError('Subscriptions have been disabled', {
+          extensions: {
+            http: {
+              status: 400, // report error with a 400
+            },
+          },
+        })
+      }
+    },
+  }
+}

examples/node-ts/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "sourceMap": true,
+    "lib": ["esnext", "DOM", "DOM.Iterable"],
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "test"]
+}