https://github.com/cnwangjie/normalize-graphql-query
Make GraphQL queries normalized, observable and auditable.
https://github.com/cnwangjie/normalize-graphql-query
apollo graphql normalize
Last synced: 9 months ago
JSON representation
Make GraphQL queries normalized, observable and auditable.
- Host: GitHub
- URL: https://github.com/cnwangjie/normalize-graphql-query
- Owner: cnwangjie
- License: mit
- Created: 2022-05-18T05:48:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-21T17:40:00.000Z (over 2 years ago)
- Last Synced: 2025-03-11T06:49:58.992Z (10 months ago)
- Topics: apollo, graphql, normalize
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/normalize-graphql-query
- Size: 751 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Normalize GraphQL Query
[](https://github.com/cnwangjie/normalize-graphql-query/actions/workflows/build.yaml)
[](https://www.npmjs.com/package/normalize-graphql-query)
## Usage
**Apollo Server**
```diff
+ import { apolloPlugin as normalize } from 'normalize-graphql-query'
export const createServer = () => {
const schema = makeExecutableSchema({ typeDefs, resolvers })
const server = new ApolloServer({
schema,
plugins: [
+ normalize(), // <-- just add this plugin
],
})
return { server, schema }
}
```
**Other GraphQL Server**
```ts
import {
normalizeGraphQLQuery,
transformGraphQLResponse,
} from 'normalize-graphql-query'
// normalize the query & variables of the request
const normalized = normalizeGraphQLQuery({
query,
variables,
})
// then you can use it to execute the query
const response = await server.executeOperation(normalized)
// transform the response data to satisfy the original query
const data = transformGraphQLResponse(normalized, response.data)
```
## Why you need it
Consider you have a GraphQL API like this.
But sometimes you will get some queries like this.
```graphql
query ($_1kjtl64174kta: ID!) {
generationModelVersionquery_14tc0yqlfqwfc: generationModelVersion(id: $_1kjtl64174kta) {
__typename
idgenerationModelVersion_42c46wm2gnbc: id
modelIdgenerationModelVersion_42c46wm2gnbc: modelId
modelgenerationModelVersion_42c46wm2gnbc: model {
__typename
extragenerationModel_42c46wm2gnbc: extra
idgenerationModel_42c46wm2gnbc: id
idgenerationModel_42c46wm2gnbc: id
authorgenerationModel_42c46wm2gnbc: author {
__typename
profilesuser_42c46wm2gnbc: profiles
iduser_42c46wm2gnbc: id
usernameuser_42c46wm2gnbc: username
displayNameuser_42c46wm2gnbc: displayName
avatarMediauser_42c46wm2gnbc: avatarMedia {
__typename
idmedia_42c46wm2gnbc: id
typemedia_42c46wm2gnbc: type
widthmedia_42c46wm2gnbc: width
heightmedia_42c46wm2gnbc: height
imageTypemedia_42c46wm2gnbc: imageType
urlsmedia_42c46wm2gnbc: urls {
__typename
variantimageUrl_42c46wm2gnbc: variant
urlimageUrl_42c46wm2gnbc: url
}
}
}
# ...
```
After you normalize it, you will get a query like this.
```graphql
query task($id: ID!) {
task(id: $id) {
__typename
outputs
parameters
id
priority
artworkId
media {
__typename
id
type
width
height
imageType
urls {
__typename
variant
url
# ...
```
You will get the same query if their structure is the same.
## License
MIT License