@ttoss/graphql-api-server 0.1.0 → 0.2.1

package/README.md

@@ -30,8 +30,13 @@ server.listen(3000, () => {
 
 The server supports the following authentication types:
 
+- No authentication
 - [`AWS_COGNITO_USER_POOLS`](#aws_cognito_user_pools)
 
+### No authentication
+
+You can disable authentication by not setting the `authenticationType` option.
+
 ### AWS_COGNITO_USER_POOLS
 
 You need to set Cognito user pool [ID token](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-id-token.html) or [access token](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-access-token.html) to the `Authorization` header.
@@ -54,3 +59,41 @@ server.listen(3000, () => {
   console.log('Server listening on port 3000');
 });
 ```
+
+### Middlewares
+
+You can add middlewares compatible with [`graphql-middleware`](https://github.com/dimatill/graphql-middleware) to the server using the `middlewares` option.
+
+```ts
+import { createServer } from '@ttoss/graphql-api-server';
+import { schemaComposer } from './schemaComposer';
+import { allow, deny, shield } from 'graphql-shield';
+
+const NotAuthorizedError = new Error('Not authorized!');
+/**
+ * The error name is the same value `errorType` on GraphQL errors response.
+ */
+NotAuthorizedError.name = 'NotAuthorizedError';
+
+const permissions = shield(
+  {
+    Query: {
+      '*': deny,
+      author: allow,
+    },
+    Author: {
+      id: allow,
+      name: allow,
+    },
+  },
+  {
+    fallbackRule: deny,
+    fallbackError: NotAuthorizedError,
+  }
+);
+
+const server = createServer({
+  schemaComposer,
+  middlewares: [permissions],
+});
+```

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/index.ts
+import { buildSchema } from "@ttoss/graphql-api";
 import { CognitoJwtVerifier } from "aws-jwt-verify";
 import { getGraphQLParameters, processRequest, renderGraphiQL, sendResult, shouldRenderGraphiQL } from "graphql-helix";
 import Koa from "koa";
@@ -8,10 +9,10 @@ import Router from "@koa/router";
 import bodyParser from "koa-bodyparser";
 import cors from "@koa/cors";
 var createServer = ({
-  schemaComposer,
   graphiql = false,
   authenticationType,
-  userPoolConfig
+  userPoolConfig,
+  ...buildSchemaInput
 }) => {
   const server = new Koa();
   const router = new Router();
@@ -61,7 +62,7 @@ var createServer = ({
       query,
       variables,
       request,
-      schema: schemaComposer.buildSchema(),
+      schema: buildSchema(buildSchemaInput),
       contextFactory: () => {
         return {
           identity: ctx.identity

package/dist/index.d.ts

@@ -1,17 +1,17 @@
-import { SchemaComposer } from '@ttoss/graphql-api';
+import { BuildSchemaInput } from '@ttoss/graphql-api';
 import Koa from 'koa';
 export { default as Router } from '@koa/router';
 
 type AuthenticationType = 'AMAZON_COGNITO_USER_POOLS';
-declare const createServer: ({ schemaComposer, graphiql, authenticationType, userPoolConfig, }: {
-    schemaComposer: SchemaComposer<any>;
-    graphiql?: boolean | undefined;
-    authenticationType?: "AMAZON_COGNITO_USER_POOLS" | undefined;
+type CreateServerInput = {
+    graphiql?: boolean;
+    authenticationType?: AuthenticationType;
     userPoolConfig?: {
         userPoolId: string;
-        tokenUse?: "access" | "id" | undefined;
+        tokenUse?: 'access' | 'id';
         clientId: string;
-    } | undefined;
-}) => Koa;
+    };
+} & BuildSchemaInput;
+declare const createServer: ({ graphiql, authenticationType, userPoolConfig, ...buildSchemaInput }: CreateServerInput) => Koa;
 
-export { AuthenticationType, createServer };
+export { AuthenticationType, CreateServerInput, createServer };

package/dist/index.js

@@ -42,6 +42,7 @@ __export(src_exports, {
   createServer: () => createServer
 });
 module.exports = __toCommonJS(src_exports);
+var import_graphql_api = require("@ttoss/graphql-api");
 var import_aws_jwt_verify = require("aws-jwt-verify");
 var import_graphql_helix = require("graphql-helix");
 var import_koa = __toESM(require("koa"));
@@ -49,10 +50,10 @@ var import_router = __toESM(require("@koa/router"));
 var import_koa_bodyparser = __toESM(require("koa-bodyparser"));
 var import_cors = __toESM(require("@koa/cors"));
 var createServer = ({
-  schemaComposer,
   graphiql = false,
   authenticationType,
-  userPoolConfig
+  userPoolConfig,
+  ...buildSchemaInput
 }) => {
   const server = new import_koa.default();
   const router = new import_router.default();
@@ -102,7 +103,7 @@ var createServer = ({
       query,
       variables,
       request,
-      schema: schemaComposer.buildSchema(),
+      schema: (0, import_graphql_api.buildSchema)(buildSchemaInput),
       contextFactory: () => {
         return {
           identity: ctx.identity

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api-server",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "GraphQL API Server",
   "author": "ttoss",
   "contributors": [
@@ -24,8 +24,7 @@
   },
   "peerDependencies": {
     "graphql": "^16.6.0",
-    "graphql-compose": "^9.0.10",
-    "@ttoss/graphql-api": "^0.2.0"
+    "@ttoss/graphql-api": "^0.3.1"
   },
   "devDependencies": {
     "@types/koa": "^2.13.6",
@@ -33,11 +32,10 @@
     "@types/koa__router": "^12.0.0",
     "@types/koa-bodyparser": "^4.3.10",
     "graphql": "^16.6.0",
-    "graphql-compose": "^9.0.10",
     "jest": "^29.5.0",
     "tsup": "^6.7.0",
-    "@ttoss/config": "^1.30.0",
-    "@ttoss/graphql-api": "^0.2.0"
+    "@ttoss/config": "^1.30.1",
+    "@ttoss/graphql-api": "^0.3.1"
   },
   "keywords": [
     "api",

package/src/index.ts

@@ -1,5 +1,5 @@
+import { type BuildSchemaInput, buildSchema } from '@ttoss/graphql-api';
 import { CognitoJwtVerifier } from 'aws-jwt-verify';
-import { type SchemaComposer } from '@ttoss/graphql-api';
 import {
   getGraphQLParameters,
   processRequest,
@@ -16,13 +16,7 @@ export { Router };
 
 export type AuthenticationType = 'AMAZON_COGNITO_USER_POOLS';
 
-export const createServer = ({
-  schemaComposer,
-  graphiql = false,
-  authenticationType,
-  userPoolConfig,
-}: {
-  schemaComposer: SchemaComposer<any>;
+export type CreateServerInput = {
   graphiql?: boolean;
   authenticationType?: AuthenticationType;
   userPoolConfig?: {
@@ -30,7 +24,14 @@ export const createServer = ({
     tokenUse?: 'access' | 'id';
     clientId: string;
   };
-}): Koa => {
+} & BuildSchemaInput;
+
+export const createServer = ({
+  graphiql = false,
+  authenticationType,
+  userPoolConfig,
+  ...buildSchemaInput
+}: CreateServerInput): Koa => {
   const server = new Koa();
 
   const router = new Router();
@@ -91,7 +92,7 @@ export const createServer = ({
       query,
       variables,
       request,
-      schema: schemaComposer.buildSchema(),
+      schema: buildSchema(buildSchemaInput),
       contextFactory: () => {
         return {
           identity: ctx.identity,