Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ManUtopiK/fastify-hasura
A Fastify plugin to have fun with Hasura.
https://github.com/ManUtopiK/fastify-hasura
fastify fastify-plugin graphql hasura
Last synced: 29 days ago
JSON representation
A Fastify plugin to have fun with Hasura.
- Host: GitHub
- URL: https://github.com/ManUtopiK/fastify-hasura
- Owner: ManUtopiK
- License: mit
- Created: 2021-03-01T13:22:38.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T06:06:08.000Z (3 months ago)
- Last Synced: 2024-10-05T03:43:25.080Z (2 months ago)
- Topics: fastify, fastify-plugin, graphql, hasura
- Language: JavaScript
- Homepage:
- Size: 406 KB
- Stars: 32
- Watchers: 3
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - fastify-hasura
- awesome-hasura - fastify-hasura - A Fastify plugin to have fun with Hasura. (Tools and Extensions)
README
# fastify-hasura
[](https://www.npmjs.com/package/fastify-hasura)
[](https://coveralls.io/github/ManUtopiK/fastify-hasura?branch=master)
A [Fastify](https://github.com/fastify/fastify) plugin to have fun with [Hasura](https://github.com/hasura/graphql-engine).
## Features
- Fastify decorator over [graphql-request](https://github.com/prisma/graphql-request) to easily request Hasura graphql endpoint.
- Provide routes for Hasura events, actions and cron jobs.
- Secure requests coming from Hasura.
- Easily register handler for Hasura events, actions and cron jobs.
## Install
1. Install fastify-hasura with:
```sh
yarn add fastify-hasura # or npm i --save fastify-hasura
```
2. Register the plugin:
```js
fastify.register(require('fastify-hasura'), {
endpoint: 'yourHasuraGraphqlEndpoint',
admin_secret: 'yourAdminSecret'
})
```
## Usage
**Example request on Hasura Graphql Endpoint**
```js
const userId = 'yourUserUUID'
const fetchUser = `#graphql
query fetchUser($id: uuid!) {
user: user_by_pk(id: $id) {
password
}
}
`
const { user } = await fastify.hasura.graphql(fetchUser, {
id: userId
})
```
**Example registering event and action:**
```js
// Register new_user hasura event
fastify.hasura.registerEvent('new_user', (request, reply) => {
const user = request.event.getNewData()
console.log(user)
})
// Register login hasura action
fastify.hasura.registerAction('login', async (request, reply) => {
const data = request.action.getData('id', 'type', 'user')
console.log(data)
const response = await yourAsyncCustomBusinessLogic(data)
reply.send(response)
})
```
_**Note:** Requests for events and actions are decorated with [hasura-parser](https://github.com/snotra-org/hasura-parser). So, you can easily retrieve data in routes with `request.event` and `request.action`._
### Options
- `endpoint` **[ required ]**: Your Hasura Graphql Endpoint.
- `admin_secret` **[ required ]**: Your Hasura admin secret.
- `api_secret` **[ optional ]**: _Highly recommended._ Provide an api secret if you want to secure requests from your Hasura instance to your Fastify app. You must configure `x-hasura-from-env` headers of all Hasura events, actions and cron jobs with this api secret.
- `routes_prefix` **[ optional ]**: By default, this plugin build root routes for `/events`, `/actions` and `/crons`. Use this option if you want to prefix this routes. Eg: `/hasura` will build routes `/hasura/events` and so on...
**All options:**
```js
fastify.register(require('fastify-hasura'), {
endpoint: 'yourHasuraGraphqlEndpoint',
admin_secret: 'yourAdminSecret',
api_secret: 'yourApiSecret',
routes_prefix: '/hasura'
})
```
## More documentation
- [Hasura GraphQL Engine Documentation](https://hasura.io/docs/latest/graphql/core/index.html)
- [graphql-request](https://www.npmjs.com/package/graphql-request)
- [hasura-parser](https://github.com/snotra-org/hasura-parser)
## Contributions
If you would like to make any contribution you are welcome to do so.
## License
Licensed under [MIT](https://github.com/ManUtopiK/fastify-hasura/blob/master/LICENSE)