@ttoss/graphql-api-server 0.5.1 → 0.5.3

package/README.md

@@ -8,7 +8,7 @@ This package provides a Koa server to run your [`@ttoss/graphql-api` API](https:
 pnpm add @ttoss/graphql-api-server @ttoss/graphql-api graphql
 ```
 
-## Quickstart
+## Getting Started
 
 You can use the `createServer` method to create your server.
 
@@ -60,7 +60,7 @@ server.listen(3000, () => {
 });
 ```
 
-### Middlewares
+## Middlewares
 
 You can add middlewares compatible with [`graphql-middleware`](https://github.com/dimatill/graphql-middleware) to the server using the `middlewares` option.
 
@@ -97,3 +97,77 @@ const server = createServer({
   middlewares: [permissions],
 });
 ```
+
+## Handling Other Routes
+
+If you want to handle other routes than `/graphql`, you can use the `Router` class from `koa` and add it to the server.
+
+### Serving a SPA
+
+```ts
+import { createServer } from '@ttoss/graphql-api-server';
+import { schemaComposer } from './schemaComposer';
+import mount from 'koa-mount';
+import * as path from 'path';
+
+const server = createServer({
+  schemaComposer,
+  graphiql: true,
+});
+
+const APP_DIR = path.resolve(__dirname, '../../app/dist');
+
+server.use(mount('/', serve(APP_DIR)));
+
+/**
+ * Serve a SPA—redirect all requests to index.html
+ * https://dejanvasic.wordpress.com/2020/08/22/serving-react-spa-in-koa/
+ */
+server.use(async (ctx, next) => {
+  return await serve(APP_DIR)(Object.assign(ctx, { path: 'index.html' }), next);
+});
+
+server.listen(3000, () => {
+  console.log('Server listening on port 3000');
+});
+```
+
+### Serving Another Endpoint
+
+```ts
+import { Router, createServer } from '@ttoss/graphql-api-server';
+import { schemaComposer } from './schemaComposer';
+
+const server = createServer({
+  schemaComposer,
+  graphiql: true,
+});
+
+const router = new Router();
+
+router.get('/health', (ctx: any) => {
+  ctx.body = 'OK';
+});
+
+server.use(router.routes()).use(router.allowedMethods());
+
+server.listen(3000, () => {
+  console.log('Server listening on port 3000');
+});
+```
+
+## CORS
+
+You can enable CORS by setting the `cors` option. You can check the available options on [@koa/cors package](https://github.com/koajs/cors?tab=readme-ov-file#corsoptions).
+
+```ts
+import { createServer } from '@ttoss/graphql-api-server';
+
+const server = createServer({
+  schemaComposer,
+  cors: {
+    origin: '*',
+    allowMethods: ['GET', 'POST'],
+  },
+});
+```

package/dist/esm/index.js

@@ -6,12 +6,22 @@ import { CognitoJwtVerifier } from "@ttoss/auth-core/amazon-cognito";
 import { createYoga } from "graphql-yoga";
 import Koa from "koa";
 import Router from "@koa/router";
+import cors from "@koa/cors";
 var createServer = ({
   authenticationType,
   userPoolConfig,
+  graphiql,
+  cors: corsOptions,
   ...buildSchemaInput
 }) => {
   const app = new Koa();
+  app.use(cors(corsOptions));
+  const yoga = createYoga({
+    schema: buildSchema(buildSchemaInput),
+    graphiql,
+    landingPage: false,
+    logging: false
+  });
   const jwtVerifier = (() => {
     if (authenticationType === "AMAZON_COGNITO_USER_POOLS") {
       if (!userPoolConfig) {
@@ -24,17 +34,15 @@ var createServer = ({
     }
     return null;
   })();
-  app.use(async ctx => {
-    const request = {
-      body: ctx.request.body,
-      headers: ctx.headers,
-      method: ctx.method,
-      query: ctx.request.query
-    };
-    if (request.method !== "GET" && request.headers.referer !== "http://localhost:4000/graphql") {
+  app.use(async (ctx, next) => {
+    if (ctx.path !== "/graphql") {
+      return next();
+    }
+    const isGraphiqlRequest = ctx.headers.accept?.includes("text/html") && graphiql;
+    if (!isGraphiqlRequest) {
       try {
         if (authenticationType === "AMAZON_COGNITO_USER_POOLS" && jwtVerifier) {
-          const token = request.headers.authorization?.replace("Bearer ", "");
+          const token = ctx.headers.authorization?.replace("Bearer ", "");
           const identity = await jwtVerifier.verify(token || "");
           ctx.identity = identity;
         }
@@ -44,13 +52,6 @@ var createServer = ({
         return;
       }
     }
-    const operationName = request.body;
-    const query = request.headers;
-    const variables = request.method;
-    const yoga = createYoga({
-      schema: buildSchema(buildSchemaInput),
-      logging: false
-    });
     const response = await yoga.handleNodeRequest(ctx.req, ctx);
     ctx.status = response.status;
     for (const [key, value] of response.headers.entries()) {

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { BuildSchemaInput } from '@ttoss/graphql-api';
 import Koa from 'koa';
 export { default as Router } from '@koa/router';
+import cors from '@koa/cors';
 
 type AuthenticationType = 'AMAZON_COGNITO_USER_POOLS';
 type CreateServerInput = {
@@ -11,7 +12,8 @@ type CreateServerInput = {
         tokenUse?: 'access' | 'id';
         clientId: string;
     };
+    cors?: cors.Options;
 } & BuildSchemaInput;
-declare const createServer: ({ authenticationType, userPoolConfig, ...buildSchemaInput }: CreateServerInput) => Koa;
+declare const createServer: ({ authenticationType, userPoolConfig, graphiql, cors: corsOptions, ...buildSchemaInput }: CreateServerInput) => Koa;
 
 export { type AuthenticationType, type CreateServerInput, createServer };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { BuildSchemaInput } from '@ttoss/graphql-api';
 import Koa from 'koa';
 export { default as Router } from '@koa/router';
+import cors from '@koa/cors';
 
 type AuthenticationType = 'AMAZON_COGNITO_USER_POOLS';
 type CreateServerInput = {
@@ -11,7 +12,8 @@ type CreateServerInput = {
         tokenUse?: 'access' | 'id';
         clientId: string;
     };
+    cors?: cors.Options;
 } & BuildSchemaInput;
-declare const createServer: ({ authenticationType, userPoolConfig, ...buildSchemaInput }: CreateServerInput) => Koa;
+declare const createServer: ({ authenticationType, userPoolConfig, graphiql, cors: corsOptions, ...buildSchemaInput }: CreateServerInput) => Koa;
 
 export { type AuthenticationType, type CreateServerInput, createServer };

package/dist/index.js

@@ -47,12 +47,22 @@ var import_amazon_cognito = require("@ttoss/auth-core/amazon-cognito");
 var import_graphql_yoga = require("graphql-yoga");
 var import_koa = __toESM(require("koa"));
 var import_router = __toESM(require("@koa/router"));
+var import_cors = __toESM(require("@koa/cors"));
 var createServer = ({
   authenticationType,
   userPoolConfig,
+  graphiql,
+  cors: corsOptions,
   ...buildSchemaInput
 }) => {
   const app = new import_koa.default();
+  app.use((0, import_cors.default)(corsOptions));
+  const yoga = (0, import_graphql_yoga.createYoga)({
+    schema: (0, import_graphql_api.buildSchema)(buildSchemaInput),
+    graphiql,
+    landingPage: false,
+    logging: false
+  });
   const jwtVerifier = (() => {
     if (authenticationType === "AMAZON_COGNITO_USER_POOLS") {
       if (!userPoolConfig) {
@@ -65,17 +75,15 @@ var createServer = ({
     }
     return null;
   })();
-  app.use(async ctx => {
-    const request = {
-      body: ctx.request.body,
-      headers: ctx.headers,
-      method: ctx.method,
-      query: ctx.request.query
-    };
-    if (request.method !== "GET" && request.headers.referer !== "http://localhost:4000/graphql") {
+  app.use(async (ctx, next) => {
+    if (ctx.path !== "/graphql") {
+      return next();
+    }
+    const isGraphiqlRequest = ctx.headers.accept?.includes("text/html") && graphiql;
+    if (!isGraphiqlRequest) {
       try {
         if (authenticationType === "AMAZON_COGNITO_USER_POOLS" && jwtVerifier) {
-          const token = request.headers.authorization?.replace("Bearer ", "");
+          const token = ctx.headers.authorization?.replace("Bearer ", "");
           const identity = await jwtVerifier.verify(token || "");
           ctx.identity = identity;
         }
@@ -85,13 +93,6 @@ var createServer = ({
         return;
       }
     }
-    const operationName = request.body;
-    const query = request.headers;
-    const variables = request.method;
-    const yoga = (0, import_graphql_yoga.createYoga)({
-      schema: (0, import_graphql_api.buildSchema)(buildSchemaInput),
-      logging: false
-    });
     const response = await yoga.handleNodeRequest(ctx.req, ctx);
     ctx.status = response.status;
     for (const [key, value] of response.headers.entries()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api-server",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "GraphQL API Server",
   "author": "ttoss",
   "contributors": [
@@ -24,7 +24,6 @@
     "@koa/router": "^12.0.1",
     "graphql-yoga": "^5.1.1",
     "koa": "^2.15.0",
-    "koa-bodyparser": "^4.4.1",
     "@ttoss/auth-core": "^0.0.2"
   },
   "peerDependencies": {
@@ -35,7 +34,6 @@
     "@types/koa": "^2.14.0",
     "@types/koa__cors": "^5.0.0",
     "@types/koa__router": "^12.0.4",
-    "@types/koa-bodyparser": "^4.3.12",
     "@types/supertest": "^6.0.2",
     "graphql": "^16.8.1",
     "jest": "^29.7.0",

package/src/index.ts

@@ -3,6 +3,7 @@ import { CognitoJwtVerifier } from '@ttoss/auth-core/amazon-cognito';
 import { createYoga } from 'graphql-yoga';
 import Koa from 'koa';
 import Router from '@koa/router';
+import cors from '@koa/cors';
 
 export { Router };
 
@@ -16,15 +17,30 @@ export type CreateServerInput = {
     tokenUse?: 'access' | 'id';
     clientId: string;
   };
+  cors?: cors.Options;
 } & BuildSchemaInput;
 
 export const createServer = ({
   authenticationType,
   userPoolConfig,
+  graphiql,
+  cors: corsOptions,
   ...buildSchemaInput
 }: CreateServerInput): Koa => {
   const app = new Koa();
 
+  app.use(cors(corsOptions));
+
+  /**
+   * https://the-guild.dev/graphql/yoga-server/docs/integrations/integration-with-koa
+   */
+  const yoga = createYoga<Koa.ParameterizedContext>({
+    schema: buildSchema(buildSchemaInput),
+    graphiql,
+    landingPage: false,
+    logging: false,
+  });
+
   const jwtVerifier = (() => {
     if (authenticationType === 'AMAZON_COGNITO_USER_POOLS') {
       if (!userPoolConfig) {
@@ -41,23 +57,27 @@ export const createServer = ({
     return null;
   })();
 
-  app.use(async (ctx) => {
-    const request = {
-      body: ctx.request.body,
-      headers: ctx.headers,
-      method: ctx.method,
-      query: ctx.request.query,
-    };
-
-    if (
-      request.method !== 'GET' &&
-      request.headers.referer !== 'http://localhost:4000/graphql'
-    ) {
+  app.use(async (ctx, next) => {
+    /**
+     * Check if the request is for the GraphQL endpoint.
+     * If not, pass it to the next middleware.
+     */
+    if (ctx.path !== '/graphql') {
+      return next();
+    }
+
+    const isGraphiqlRequest =
+      ctx.headers.accept?.includes('text/html') && graphiql;
+
+    /**
+     * If the request is not a GraphiQL request, verify the JWT token, else
+     * set Unauthorized status code and return.
+     */
+    if (!isGraphiqlRequest) {
       try {
         if (authenticationType === 'AMAZON_COGNITO_USER_POOLS' && jwtVerifier) {
-          const token = request.headers.authorization?.replace('Bearer ', '');
+          const token = ctx.headers.authorization?.replace('Bearer ', '');
           const identity = await jwtVerifier.verify(token || '');
-
           ctx.identity = identity;
         }
       } catch {
@@ -67,25 +87,16 @@ export const createServer = ({
       }
     }
 
-    //console.log(ctx.identity);
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const operationName = request.body;
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const query = request.headers;
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const variables = request.method;
-
-    const yoga = createYoga<Koa.ParameterizedContext>({
-      schema: buildSchema(buildSchemaInput),
-      logging: false,
-    });
-
     const response = await yoga.handleNodeRequest(ctx.req, ctx);
 
-    // Set status code
+    /**
+     * Set status code
+     */
     ctx.status = response.status;
 
-    // Set headers
+    /**
+     * Set headers
+     */
     for (const [key, value] of response.headers.entries()) {
       if (ctx.status != 401) {
         ctx.append(key, value);

package/src/typings.d.ts

@@ -1 +0,0 @@
-declare module 'graphql-helix';