@ttoss/appsync-api 0.14.0 → 0.15.0

package/README.md

@@ -18,7 +18,7 @@ You can create and deploy an AppSync API in four steps:
 
 ```typescript
 import { createApiTemplate } from '@ttoss/appsync-api';
-import { schemaComposer } from '@ttoss/graphql-api';
+import { schemaComposer } from './schemaComposer';
 
 const template = createApiTemplate({
   schemaComposer,
@@ -41,7 +41,7 @@ export default template;
 
 ```typescript
 import { createAppSyncResolverHandler } from '@ttoss/appsync-api';
-import { schemaComposer } from '@ttoss/graphql-api';
+import { schemaComposer } from './schemaComposer';
 
 export const handler = createAppSyncResolverHandler({ schemaComposer });
 ```
@@ -58,3 +58,43 @@ Now you can deploy your API using `carlin deploy`:
 ```bash
 carlin deploy
 ```
+
+## Advanced Usage
+
+### Middlewares
+
+You can add middlewares compatible with [`graphql-middleware`](https://github.com/dimatill/graphql-middleware) to the server using the `middlewares` option.
+
+```ts
+import { createAppSyncResolverHandler } from '@ttoss/appsync-api';
+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,
+  }
+);
+
+export const handler = createAppSyncResolverHandler({
+  schemaComposer,
+  middlewares: [permissions],
+});
+```

package/dist/esm/index.js

@@ -1,7 +1,7 @@
 /** Powered by @ttoss/config. https://ttoss.dev/docs/modules/packages/config/ */
 
 // src/createApiTemplate.ts
-import { graphql } from "graphql-compose";
+import { graphql } from "@ttoss/graphql-api";
 
 // ../../node_modules/.pnpm/tslib@2.5.0/node_modules/tslib/tslib.es6.js
 var __assign = function () {
@@ -80,7 +80,7 @@ var getPackageLambdaLayerStackName = packageName => {
 // package.json
 var package_default = {
   name: "@ttoss/appsync-api",
-  version: "0.14.0",
+  version: "0.15.0",
   description: "A library for building GraphQL APIs for AWS AppSync.",
   license: "UNLICENSED",
   author: "ttoss",
@@ -95,32 +95,26 @@ var package_default = {
   sideEffects: false,
   typings: "dist/index.d.ts",
   dependencies: {
-    "@ttoss/cloudformation": "workspace:^",
-    "@ttoss/graphql-api": "workspace:^"
+    "@ttoss/cloudformation": "workspace:^"
   },
   peerDependencies: {
-    graphql: "^16.6.0",
-    "graphql-compose": "^9.0.10"
+    "@ttoss/graphql-api": "workspace:^",
+    graphql: "^16.6.0"
   },
   devDependencies: {
     "@ttoss/config": "workspace:^",
+    "@ttoss/graphql-api": "workspace:^",
     "@ttoss/relay-amplify": "workspace:^",
     "@types/aws-lambda": "^8.10.115",
     carlin: "workspace:^",
     graphql: "^16.6.0",
-    "graphql-compose": "^9.0.10",
+    "graphql-shield": "^7.6.5",
     jest: "^29.5.0",
     tsup: "^6.7.0"
   },
   keywords: ["api", "appsync", "aws", "graphql"],
   publishConfig: {
     access: "public"
-  },
-  typesVersions: {
-    "*": {
-      ".": ["./dist/index.d.ts"],
-      server: ["./dist/server.d.ts"]
-    }
   }
 };
 
@@ -159,11 +153,13 @@ var createApiTemplate = ({
       };
     });
   }).filter(Boolean);
-  const getGraphQLComposeDependenciesLambdaLayers = () => {
+  const getPeerDependenciesLambdaLayers = () => {
     const {
       peerDependencies
     } = package_default;
-    const lambdaLayerStackNames = Object.entries(peerDependencies).map(([dependencyName, dependencyVersion]) => {
+    const lambdaLayerStackNames = Object.entries(peerDependencies).filter(([dependencyName]) => {
+      return ["graphql"].includes(dependencyName);
+    }).map(([dependencyName, dependencyVersion]) => {
       return getPackageLambdaLayerStackName([dependencyName, dependencyVersion].join("@"));
     });
     return lambdaLayerStackNames.map(lambdaLayerStackName => {
@@ -226,7 +222,7 @@ var createApiTemplate = ({
             }
           },
           Handler: "index.handler",
-          Layers: getGraphQLComposeDependenciesLambdaLayers(),
+          Layers: getPeerDependenciesLambdaLayers(),
           MemorySize: 512,
           Role: lambdaFunction.roleArn,
           Runtime: "nodejs18.x",
@@ -346,6 +342,9 @@ var createApiTemplate = ({
   return template;
 };
 
+// src/createAppSyncResolverHandler.ts
+import { buildSchema } from "@ttoss/graphql-api";
+
 // ../relay-amplify/src/encodeCredentials.ts
 var decodeCredentials = credentials => {
   return JSON.parse(Buffer.from(credentials, "base64").toString("utf8"));
@@ -353,7 +352,7 @@ var decodeCredentials = credentials => {
 
 // src/createAppSyncResolverHandler.ts
 var createAppSyncResolverHandler = ({
-  schemaComposer
+  ...buildSchemaInput
 }) => {
   return async (event, context) => {
     const {
@@ -374,14 +373,26 @@ var createAppSyncResolverHandler = ({
       }
       return decodeCredentials(headersCredentials);
     })();
-    const resolveMethods = schemaComposer.getResolveMethods();
-    const resolver = resolveMethods[parentTypeName][fieldName];
-    return resolver(source, args, {
+    const schema = buildSchema(buildSchemaInput);
+    const parentType = schema.getType(parentTypeName);
+    if (!parentType) {
+      throw new Error(`Type ${parentTypeName} not found`);
+    }
+    const field = parentType.getFields()[fieldName];
+    const resolver = field?.resolve;
+    if (!resolver) {
+      throw new Error(`Resolver for ${parentTypeName}.${fieldName} not found`);
+    }
+    const response = await resolver(source, args, {
       ...context,
       identity: event.identity,
       credentials,
       headers
     }, info);
+    if (response instanceof Error) {
+      throw response;
+    }
+    return response;
   };
 };
 export { createApiTemplate, createAppSyncResolverHandler };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SchemaComposer } from 'graphql-compose';
+import { SchemaComposer, BuildSchemaInput } from '@ttoss/graphql-api';
 import { AppSyncResolverHandler as AppSyncResolverHandler$1 } from 'aws-lambda';
 export { AppSyncIdentityCognito } from 'aws-lambda';
 
@@ -109,8 +109,6 @@ declare const createApiTemplate: ({ additionalAuthenticationProviders, authentic
 }) => CloudFormationTemplate;
 
 type AppSyncResolverHandler<TArguments, TResult, TSource = Record<string, any> | null> = AppSyncResolverHandler$1<TArguments, TResult, TSource>;
-declare const createAppSyncResolverHandler: ({ schemaComposer, }: {
-    schemaComposer: SchemaComposer<any>;
-}) => AppSyncResolverHandler<any, any, any>;
+declare const createAppSyncResolverHandler: ({ ...buildSchemaInput }: BuildSchemaInput) => AppSyncResolverHandler<any, any, any>;
 
 export { AppSyncResolverHandler, createApiTemplate, createAppSyncResolverHandler };

package/dist/index.js

@@ -33,7 +33,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/createApiTemplate.ts
-var import_graphql_compose = require("graphql-compose");
+var import_graphql_api = require("@ttoss/graphql-api");
 
 // ../../node_modules/.pnpm/tslib@2.5.0/node_modules/tslib/tslib.es6.js
 var __assign = function () {
@@ -112,7 +112,7 @@ var getPackageLambdaLayerStackName = packageName => {
 // package.json
 var package_default = {
   name: "@ttoss/appsync-api",
-  version: "0.14.0",
+  version: "0.15.0",
   description: "A library for building GraphQL APIs for AWS AppSync.",
   license: "UNLICENSED",
   author: "ttoss",
@@ -127,32 +127,26 @@ var package_default = {
   sideEffects: false,
   typings: "dist/index.d.ts",
   dependencies: {
-    "@ttoss/cloudformation": "workspace:^",
-    "@ttoss/graphql-api": "workspace:^"
+    "@ttoss/cloudformation": "workspace:^"
   },
   peerDependencies: {
-    graphql: "^16.6.0",
-    "graphql-compose": "^9.0.10"
+    "@ttoss/graphql-api": "workspace:^",
+    graphql: "^16.6.0"
   },
   devDependencies: {
     "@ttoss/config": "workspace:^",
+    "@ttoss/graphql-api": "workspace:^",
     "@ttoss/relay-amplify": "workspace:^",
     "@types/aws-lambda": "^8.10.115",
     carlin: "workspace:^",
     graphql: "^16.6.0",
-    "graphql-compose": "^9.0.10",
+    "graphql-shield": "^7.6.5",
     jest: "^29.5.0",
     tsup: "^6.7.0"
   },
   keywords: ["api", "appsync", "aws", "graphql"],
   publishConfig: {
     access: "public"
-  },
-  typesVersions: {
-    "*": {
-      ".": ["./dist/index.d.ts"],
-      server: ["./dist/server.d.ts"]
-    }
   }
 };
 
@@ -175,7 +169,7 @@ var createApiTemplate = ({
     omitDescriptions: true,
     omitScalars: true
   });
-  import_graphql_compose.graphql.validateSchema(schemaComposer.buildSchema());
+  import_graphql_api.graphql.validateSchema(schemaComposer.buildSchema());
   const resolveMethods = schemaComposer.getResolveMethods();
   const resolveMethodsEntries = Object.entries(resolveMethods).flatMap(([typeName, fieldResolvers]) => {
     return Object.entries(fieldResolvers).map(([fieldName, resolver]) => {
@@ -191,11 +185,13 @@ var createApiTemplate = ({
       };
     });
   }).filter(Boolean);
-  const getGraphQLComposeDependenciesLambdaLayers = () => {
+  const getPeerDependenciesLambdaLayers = () => {
     const {
       peerDependencies
     } = package_default;
-    const lambdaLayerStackNames = Object.entries(peerDependencies).map(([dependencyName, dependencyVersion]) => {
+    const lambdaLayerStackNames = Object.entries(peerDependencies).filter(([dependencyName]) => {
+      return ["graphql"].includes(dependencyName);
+    }).map(([dependencyName, dependencyVersion]) => {
       return getPackageLambdaLayerStackName([dependencyName, dependencyVersion].join("@"));
     });
     return lambdaLayerStackNames.map(lambdaLayerStackName => {
@@ -258,7 +254,7 @@ var createApiTemplate = ({
             }
           },
           Handler: "index.handler",
-          Layers: getGraphQLComposeDependenciesLambdaLayers(),
+          Layers: getPeerDependenciesLambdaLayers(),
           MemorySize: 512,
           Role: lambdaFunction.roleArn,
           Runtime: "nodejs18.x",
@@ -378,6 +374,9 @@ var createApiTemplate = ({
   return template;
 };
 
+// src/createAppSyncResolverHandler.ts
+var import_graphql_api2 = require("@ttoss/graphql-api");
+
 // ../relay-amplify/src/encodeCredentials.ts
 var decodeCredentials = credentials => {
   return JSON.parse(Buffer.from(credentials, "base64").toString("utf8"));
@@ -385,7 +384,7 @@ var decodeCredentials = credentials => {
 
 // src/createAppSyncResolverHandler.ts
 var createAppSyncResolverHandler = ({
-  schemaComposer
+  ...buildSchemaInput
 }) => {
   return async (event, context) => {
     const {
@@ -406,14 +405,26 @@ var createAppSyncResolverHandler = ({
       }
       return decodeCredentials(headersCredentials);
     })();
-    const resolveMethods = schemaComposer.getResolveMethods();
-    const resolver = resolveMethods[parentTypeName][fieldName];
-    return resolver(source, args, {
+    const schema = (0, import_graphql_api2.buildSchema)(buildSchemaInput);
+    const parentType = schema.getType(parentTypeName);
+    if (!parentType) {
+      throw new Error(`Type ${parentTypeName} not found`);
+    }
+    const field = parentType.getFields()[fieldName];
+    const resolver = field?.resolve;
+    if (!resolver) {
+      throw new Error(`Resolver for ${parentTypeName}.${fieldName} not found`);
+    }
+    const response = await resolver(source, args, {
       ...context,
       identity: event.identity,
       credentials,
       headers
     }, info);
+    if (response instanceof Error) {
+      throw response;
+    }
+    return response;
   };
 };
 // Annotate the CommonJS export names for ESM import in node:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/appsync-api",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "A library for building GraphQL APIs for AWS AppSync.",
   "license": "UNLICENSED",
   "author": "ttoss",
@@ -16,20 +16,20 @@
   "sideEffects": false,
   "typings": "dist/index.d.ts",
   "dependencies": {
-    "@ttoss/cloudformation": "^0.7.2",
-    "@ttoss/graphql-api": "^0.2.0"
+    "@ttoss/cloudformation": "^0.7.2"
   },
   "peerDependencies": {
     "graphql": "^16.6.0",
-    "graphql-compose": "^9.0.10"
+    "@ttoss/graphql-api": "^0.3.0"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.115",
     "graphql": "^16.6.0",
-    "graphql-compose": "^9.0.10",
+    "graphql-shield": "^7.6.5",
     "jest": "^29.5.0",
     "tsup": "^6.7.0",
     "@ttoss/config": "^1.30.0",
+    "@ttoss/graphql-api": "^0.3.0",
     "@ttoss/relay-amplify": "^0.4.8",
     "carlin": "^1.29.1"
   },
@@ -42,16 +42,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "typesVersions": {
-    "*": {
-      ".": [
-        "./dist/index.d.ts"
-      ],
-      "server": [
-        "./dist/server.d.ts"
-      ]
-    }
-  },
   "scripts": {
     "build": "tsup",
     "test": "jest"

package/src/createApiTemplate.ts

@@ -1,4 +1,4 @@
-import { type SchemaComposer, graphql } from 'graphql-compose';
+import { type SchemaComposer, graphql } from '@ttoss/graphql-api';
 import { getPackageLambdaLayerStackName } from 'carlin/src/deploy/lambdaLayer/getPackageLambdaLayerStackName';
 import packageJson from '../package.json';
 
@@ -101,16 +101,18 @@ export const createApiTemplate = ({
     })
     .filter(Boolean) as Array<{ fieldName: string; typeName: string }>;
 
-  const getGraphQLComposeDependenciesLambdaLayers = () => {
+  const getPeerDependenciesLambdaLayers = () => {
     const { peerDependencies } = packageJson;
 
-    const lambdaLayerStackNames = Object.entries(peerDependencies).map(
-      ([dependencyName, dependencyVersion]) => {
+    const lambdaLayerStackNames = Object.entries(peerDependencies)
+      .filter(([dependencyName]) => {
+        return ['graphql'].includes(dependencyName);
+      })
+      .map(([dependencyName, dependencyVersion]) => {
         return getPackageLambdaLayerStackName(
           [dependencyName, dependencyVersion].join('@')
         );
-      }
-    );
+      });
 
     return lambdaLayerStackNames.map((lambdaLayerStackName) => {
       return {
@@ -166,7 +168,7 @@ export const createApiTemplate = ({
             S3ObjectVersion: { Ref: 'LambdaS3ObjectVersion' },
           },
           Handler: 'index.handler',
-          Layers: getGraphQLComposeDependenciesLambdaLayers(),
+          Layers: getPeerDependenciesLambdaLayers(),
           MemorySize: 512,
           Role: lambdaFunction.roleArn,
           Runtime: 'nodejs18.x',

package/src/createAppSyncResolverHandler.ts

@@ -1,6 +1,7 @@
+import { BuildSchemaInput, buildSchema } from '@ttoss/graphql-api';
+import { type GraphQLObjectType } from 'graphql';
 import { decodeCredentials } from '@ttoss/relay-amplify/src/encodeCredentials';
 import type { AppSyncResolverHandler as AwsAppSyncResolverHandler } from 'aws-lambda';
-import type { SchemaComposer } from 'graphql-compose';
 
 export type AppSyncResolverHandler<
   TArguments,
@@ -9,10 +10,8 @@ export type AppSyncResolverHandler<
 > = AwsAppSyncResolverHandler<TArguments, TResult, TSource>;
 
 export const createAppSyncResolverHandler = ({
-  schemaComposer,
-}: {
-  schemaComposer: SchemaComposer<any>;
-}): AppSyncResolverHandler<any, any, any> => {
+  ...buildSchemaInput
+}: BuildSchemaInput): AppSyncResolverHandler<any, any, any> => {
   return async (event, context) => {
     const { info, arguments: args, source, request } = event;
 
@@ -30,15 +29,33 @@ export const createAppSyncResolverHandler = ({
       return decodeCredentials(headersCredentials);
     })();
 
-    const resolveMethods = schemaComposer.getResolveMethods();
+    const schema = buildSchema(buildSchemaInput);
 
-    const resolver = (resolveMethods[parentTypeName] as any)[fieldName];
+    const parentType = schema.getType(parentTypeName) as GraphQLObjectType;
 
-    return resolver(
+    if (!parentType) {
+      throw new Error(`Type ${parentTypeName} not found`);
+    }
+
+    const field = parentType.getFields()[fieldName];
+
+    const resolver = field?.resolve;
+
+    if (!resolver) {
+      throw new Error(`Resolver for ${parentTypeName}.${fieldName} not found`);
+    }
+
+    const response = await resolver(
       source,
       args,
       { ...context, identity: event.identity, credentials, headers },
-      info
+      info as any
     );
+
+    if (response instanceof Error) {
+      throw response;
+    }
+
+    return response;
   };
 };