@ttoss/appsync-api 0.18.3 → 0.18.5

package/README.md

@@ -5,10 +5,10 @@ This package provides a opinionated way to create an AppSync API using [`@ttoss/
 ## Installation
 
 ```bash
-yarn add @ttoss/appsync-api @ttoss/graphql-api graphql
+pnpm add @ttoss/appsync-api @ttoss/graphql-api graphql
 ```
 
-## Quickstart
+## Getting Started
 
 You can create and deploy an AppSync API in four steps:
 
@@ -59,45 +59,15 @@ Now you can deploy your API using `carlin deploy`:
 carlin deploy
 ```
 
-## Advanced Usage
+## API
 
-### Middlewares
+### Resolvers Context
 
-You can add middlewares compatible with [`graphql-middleware`](https://github.com/dimatill/graphql-middleware) to the server using the `middlewares` option.
+The `createAppSyncResolverHandler` function adds the `context` object to the resolvers. This object contains the following properties:
 
-```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],
-});
-```
+- `handler` - [AWS Lambda context object](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-context.html).
+- `request` - AppSync request object (see [Request section](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference-js.html)).
+- `identity` - AppSync identity object (see [Identity section](https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference-js.html)).
 
 ### Custom domain name
 

package/dist/esm/index.js

@@ -266,17 +266,10 @@ var createApiTemplate = ({
 
 // 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"));
-};
-
-// src/createAppSyncResolverHandler.ts
 var createAppSyncResolverHandler = ({
   ...buildSchemaInput
 }) => {
-  return async (event, context) => {
+  return async (event, appSyncHandlerContext) => {
     const {
       schemaComposer
     } = buildSchemaInput;
@@ -290,14 +283,11 @@ var createAppSyncResolverHandler = ({
       parentTypeName,
       fieldName
     } = info;
-    const headers = request?.headers || {};
-    const credentials = (() => {
-      const headersCredentials = headers?.["x-credentials"];
-      if (!headersCredentials) {
-        return null;
-      }
-      return decodeCredentials(headersCredentials);
-    })();
+    const context = {
+      handler: appSyncHandlerContext,
+      request,
+      identity: event.identity
+    };
     const schema = buildSchema(buildSchemaInput);
     const parentType = schema.getType(parentTypeName);
     if (!parentType) {
@@ -333,12 +323,7 @@ var createAppSyncResolverHandler = ({
         ...enumArgs
       };
     })();
-    const response = await resolver(source, argsWithEnumValues, {
-      ...context,
-      identity: event.identity,
-      credentials,
-      headers
-    }, info);
+    const response = await resolver(source, argsWithEnumValues, context, info);
     if (response instanceof Error) {
       throw response;
     }

package/dist/index.js

@@ -298,17 +298,10 @@ var createApiTemplate = ({
 
 // 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"));
-};
-
-// src/createAppSyncResolverHandler.ts
 var createAppSyncResolverHandler = ({
   ...buildSchemaInput
 }) => {
-  return async (event, context) => {
+  return async (event, appSyncHandlerContext) => {
     const {
       schemaComposer
     } = buildSchemaInput;
@@ -322,14 +315,11 @@ var createAppSyncResolverHandler = ({
       parentTypeName,
       fieldName
     } = info;
-    const headers = request?.headers || {};
-    const credentials = (() => {
-      const headersCredentials = headers?.["x-credentials"];
-      if (!headersCredentials) {
-        return null;
-      }
-      return decodeCredentials(headersCredentials);
-    })();
+    const context = {
+      handler: appSyncHandlerContext,
+      request,
+      identity: event.identity
+    };
     const schema = (0, import_graphql_api2.buildSchema)(buildSchemaInput);
     const parentType = schema.getType(parentTypeName);
     if (!parentType) {
@@ -365,12 +355,7 @@ var createAppSyncResolverHandler = ({
         ...enumArgs
       };
     })();
-    const response = await resolver(source, argsWithEnumValues, {
-      ...context,
-      identity: event.identity,
-      credentials,
-      headers
-    }, info);
+    const response = await resolver(source, argsWithEnumValues, context, info);
     if (response instanceof Error) {
       throw response;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/appsync-api",
-  "version": "0.18.3",
+  "version": "0.18.5",
   "description": "A library for building GraphQL APIs for AWS AppSync.",
   "author": "ttoss",
   "contributors": [
@@ -11,31 +11,35 @@
     "url": "https://github.com/ttoss/ttoss.git",
     "directory": "packages/appsync-api"
   },
-  "main": "dist/index.js",
-  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "files": [
     "dist",
     "src"
   ],
   "sideEffects": false,
-  "typings": "dist/index.d.ts",
   "dependencies": {
-    "@ttoss/cloudformation": "^0.9.0"
+    "@ttoss/cloudformation": "^0.9.1"
   },
   "peerDependencies": {
     "graphql": "^16.6.0",
-    "@ttoss/graphql-api": "^0.5.0"
+    "@ttoss/graphql-api": "^0.5.2"
   },
   "devDependencies": {
     "@types/aws-lambda": "^8.10.130",
     "graphql": "^16.8.1",
     "graphql-shield": "^7.6.5",
     "jest": "^29.7.0",
-    "tsup": "^8.0.1",
-    "@ttoss/config": "^1.31.4",
-    "@ttoss/graphql-api": "^0.5.0",
-    "@ttoss/relay-amplify": "^0.5.5",
-    "carlin": "^1.31.11"
+    "tsup": "^8.0.2",
+    "@ttoss/config": "^1.31.5",
+    "@ttoss/graphql-api": "^0.5.2",
+    "@ttoss/ids": "^0.1.1",
+    "carlin": "^1.31.12"
   },
   "keywords": [
     "api",

package/src/createAppSyncResolverHandler.ts

@@ -1,7 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 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';
 
 export type AppSyncResolverHandler<
@@ -13,24 +12,21 @@ export type AppSyncResolverHandler<
 export const createAppSyncResolverHandler = ({
   ...buildSchemaInput
 }: BuildSchemaInput): AppSyncResolverHandler<any, any, any> => {
-  return async (event, context) => {
+  return async (event, appSyncHandlerContext) => {
     const { schemaComposer } = buildSchemaInput;
 
+    /**
+     * https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference-js.html
+     */
     const { info, arguments: args, source, request } = event;
 
     const { parentTypeName, fieldName } = info;
 
-    const headers = request?.headers || {};
-
-    const credentials = (() => {
-      const headersCredentials = headers?.['x-credentials'];
-
-      if (!headersCredentials) {
-        return null;
-      }
-
-      return decodeCredentials(headersCredentials);
-    })();
+    const context = {
+      handler: appSyncHandlerContext,
+      request,
+      identity: event.identity,
+    };
 
     const schema = buildSchema(buildSchemaInput);
 
@@ -86,7 +82,7 @@ export const createAppSyncResolverHandler = ({
     const response = await resolver(
       source,
       argsWithEnumValues,
-      { ...context, identity: event.identity, credentials, headers },
+      context,
       info as any
     );