@hydre/graphql-lambda-ws 🌐🚀

Welcome to GraphQL Serverless WebSocket library, a simple and powerful solution for implementing GraphQL subscriptions over WebSocket on Serverless architectures. 🛰️🌟

Features ✨

• AWS Integration: Built-in integration with AWS API Gateway Management API for easy deployment on AWS Lambda.
• Flexible Error Handling: Customize how errors are formatted and returned to the client.
• Built-In Validation: Automatically validates incoming GraphQL requests against your schema.

Installation 📦

Use the package manager npm to install GraphQL Serverless WebSocket Library.

npm install @hydre/graphql-lambda-ws

Server Usage 🚀

This library exposes a single function that returns a new server instance. This function takes an options object with the following properties:

The returned server instance is a function that you can use as your AWS Lambda handler.

Here is a simple usage example:

importservefrom'@hydre/graphql-lambda-ws'importmake_schemafrom'@hydre/make_schema'exportconstconnect=(_,__,cb)=>cb(null,{statusCode: 200,body: '🇺🇦'})// this returns a function (event, context) => {}exportdefaultserve({// the build schemaschema: make_schema({ ... }),// An async function that builds the context for each request.// `set_headers` can be called to assign headers to the responsebuild_context: async({ event, context, set_headers })=>({}),// The root value for your resolversroot_value: {},// Options for the AWS API Gateway Management API client. @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-apigatewaymanagementapi/aws_client_options: {endpoint: 'http://localhost:3001'},// A function that formats errors before they're returned to the client.format_error: error=>error,// log every lambda responseslog_response: false})

You may use it along Serverless like this

service: my-serviceframeworkVersion: '3'useDotenv: trueprovider:
name: awsruntime: nodejs18.xfunctions:
connect:
handler: src/index.connectevents:
- websocket:
route: $connectdefault:
handler: src/index.defaultevents:
- websocket:
route: $defaultplugins:
- serverless-dotenv-plugin
- serverless-offline

Now run

sls offline

Client usage 🍎

Try it in your terminal with wscat

wscat -c ws://localhost:3001
> {"query":"subscription { test }"}

Find a vuejs example under /example/index.js

Contributing 🤝

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to test your changes