Gathering detailed insights and metrics for aws-lambda-graphql
apollo-server-lambda
Production-ready Node.js GraphQL server for AWS Lambda
graphql-lambda-subscriptions
Graphql-WS compatible Lambda Powered Subscriptions
aws-lambda-graphql-apollo-v3
Apollo server for AWS Lambda with WebSocket subscriptions support over API Gateway v1 + v2
aws-lambda-graphql-subscriptions
npm install aws-lambda-graphqlTypescript
Module System
Min. Node Version
Node Version
NPM Version
57
Supply Chain
87
Quality
69.3
Maintenance
50
Vulnerability
97
License
TypeScript (98.24%)
JavaScript (0.88%)
HTML (0.76%)
Shell (0.12%)
Total Downloads
899,468
Last Day
677
Last Week
3,656
Last Month
14,502
Last Year
139,215
462 Stars
275 Commits
90 Forks
18 Watching
20 Branches
17 Contributors
Minified
Minified + Gzipped
Latest Version
1.0.0-alpha.24
Package Id
aws-lambda-graphql@1.0.0-alpha.24
Unpacked Size
229.36 kB
Size
49.24 kB
File Count
136
NPM Version
lerna/3.22.1/node@v14.17.6+x64 (darwin)
Node Version
14.17.6
Cumulative downloads
Total Downloads
Last day
-48.1%
677
Compared to previous day
Last week
-28.8%
3,656
Compared to previous week
Last month
82%
14,502
Compared to previous month
Last year
-48.9%
139,215
Compared to previous year
⚠️ This documentation is currently for 1.0.0-alpha.X package which supports only subscriptions-transport-ws and drops the legacy protocol and client support! To use old version that supports legacy protocol and client see the link 0.13.0 below.
📖Documentation for aws-lambda-graphql0.13.0
Use Apollo Server Lambda with GraphQL subscriptions over WebSocket (AWS API Gateway v2).
With this library you can do:
1yarn add aws-lambda-graphql graphql graphql-subscriptions 2# or 3npm install aws-lamda-graphql graphql graphql-subscriptions
There is a quick start guide.
## API
ServerCreates an Apollo Lambda server.
All options from Apollo Lambda Server and
IConnectionManager, required)IEventProcessor, required)(err: any) => void, optional) - use to log errors from websocket handler on unknown errorISubscriptionManager, required)optional)
onWebsocketConnect(connection: IConnection, event: APIGatewayWebSocketEvent, context: LambdaContext): Promise<boolean|object> | object | boolean (optional) - onWebsocketConnect is called when the Websocket connection is initialized ($connect route). Return an object to set a context to your connection object saved in the database e.g. for saving authentication details. This is especially useful to get authentication details (API GW authorizers only run in $connect route)onConnect(messagePayload: object, connection: IConnection, event: APIGatewayWebSocketEvent, context: LambdaContext): Promise<boolean|object> | object | boolean (optional) - onConnect is called when the GraphQL connection is initialized (connection_init message). Return an object to set a context to your connection object saved in the database e.g. for saving authentication details. NOTE: This is not the websocket $connect route, see onWebsocketConnect for the $connect route.onOperation(message: OperationRequest, params: ExecutionParams, connection: IConnection): Promise<ExecutionParams>|ExecutionParams (optional)onOperationComplete(connection: IConnection, operationId: string): void (optional)onDisconnect(connection: IConnection): void (optional)optional) - if connection is not initialised on GraphQL operation, wait for connection to be initialised or throw prohibited connection error. If onConnect is specified then we wait for initialisation otherwise we don't wait. (this is usefull if you're performing authentication in onConnect).
number, optional, default 10) - how many times should we try to check the connection state?number, optional, default 50ms) - how long should we wait (in milliseconds) until we try to check the connection state again?string, optional) - if specified, the connection endpoint will be registered with this value as opposed to extracted from the event payload (as ${domainName}/${stage})createHttpHandler()Creates an AWS Lambda API Gateway v1 handler. Events are handled by apollo-server-lambda
createWebSocketHandler()Creates an AWS Lambda API Gateway v2 handler that supports GraphQL subscriptions over WebSocket.
createEventHandler()Creates an AWS Lambda handler for events from events source (for example DynamoDBEventStore). This method internally work with IEventProcessor.
DynamoDBEventProcessor: IEventProcessorAWS Lambda DynamoDB stream handler. DynamoDBEventProcessor is used internally by Server.
optional)(err: any) => void, optional)boolean, default: false) - optional debug mode to add logs in CloudwatchDynamoDBConnectionManager: IConnectionManagerIConnectionManager implementation that stores information about connections to DynamoDB table, performs communication with them, etc.
Each connection is stored as IConnection object.
string, optional, default: 'Connections') - name of DynamoDB table used to store connectionsISubscriptionManager, required) - subscription manager used to register subscriptions for connections.number, optional, default: 2 hours)
ttl field on the row (you are responsible for enabling TTL on given field)boolean,optional,default: false) - optional debug mode to add logs in CloudwatchDynamoDBEventStore: IEventStoreIEventStore implemenation that used AWS DynamoDB as storage for published events.
string, optional, default: 'Events') - events DynamoDB table namenumber, optional, default: 2 hours)
ttl field on the row (you are responsible for enabling TTL on given field)DynamoDBSubscriptionManager: ISubscriptionManagerISubscriptionManager implementation that used AWS DynamoDB as storage for subscriptions.
Stores subscriptions to a subscriptions table as event: string and subscriptionId: string.Make sure to set up the key schema as event: HASH and subscriptionId: RANGE.
Stores subscription operations to a subscription operations table as subscriptionId: string. Make sure to set up the key schema as subscriptionId: HASH.
string, optional, default: 'Subscriptions')string, optional, default: 'SubscriptionOperations')number, optional, default: 2 hours)
ttl field on the row (you are responsible for enabling TTL on given field)function, optional, default: '(event: ISubscriptionEvent) => event.event')
function, optional, default: '(name: string, connection: IConnection) => name')
DynamoDBRangeSubscriptionManager: ISubscriptionManagerISubscriptionManager implementation that used AWS DynamoDB as storage for subscriptions.
Stores subscriptions to a subscriptions table as event: string and subscriptionId: string.Make sure to set up the key schema as event: HASH and subscriptionId: RANGE.
Stores subscription operations to a subscription operations table as subscriptionId: string. Make sure to set up the key schema as subscriptionId: HASH and event: RANGE.
string, optional, default: 'Subscriptions')string, optional, default: 'SubscriptionOperations')number, optional, default: 2 hours)
ttl field on the row (you are responsible for enabling TTL on given field)IConnectionIConnectionDataIConnectionDataobject) - connection context data provided from GQL_CONNECTION_INIT or onConnect. This data is passed to graphql resolvers' context. All values should be JSON seriablizable.boolean) - is connection initialised? Basically if you use onConnect then this value is false until the onConnect successfully resolves with non false value.Context creator function accepts IContext and returns an object or Promise that resolves to an object.
IContextInternal context passed to the Context creator function.
Structure:
IConnection) - current connection that invoked the execution or is associated with an operationIConnectionManager)OperationRequest) - operation associated with current invokationPubSub) - PubSub instance used by event storeISubscriptionManager)PubSubPubSub implementation that publishes events / subscribes to events using underlying event store.
boolean, default: true) - Serialize event payload to JSONboolean, default: false) - optional debug mode to add logs in Cloudwatch
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
Found 9/25 approved changesets -- score normalized to 3
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
155 existing vulnerabilities detected
Details
Score
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More