https://github.com/danielc92/graph-schema-to-query-templates
https://github.com/danielc92/graph-schema-to-query-templates
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielc92/graph-schema-to-query-templates
- Owner: danielc92
- License: mit
- Created: 2023-03-07T06:45:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T05:30:10.000Z (over 2 years ago)
- Last Synced: 2025-02-25T06:39:26.911Z (over 1 year ago)
- Language: TypeScript
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# graph-schema-to-query-templates
This repo contains code that enables conversion of graphql schema files (.gql / .graphql) into query template strings.
### Notes
- Supports mjs and cjs imports
- Supports **nested** queries and mutation types, if `searchTokens` is provided
- Currently supports building templates from Mutation and Query types. Templates are built recursively.
### Usage Example
Installation
```
npm i graphql-schema-to-query
```
For example with a schema file `test.graphql`
```
type Query {
foo: String
bar: Int
animals: AnimalQueries
}
type AnimalQueries {
birds: BirdQueries
getAnimals(names: [String!]!): [Animal]
}
type BirdQueries {
parrot: String
chicken: String
birdsWithFeathers: [Animal]
}
type Animal {
name: String
species: String
}
type Mutation {
updateBird(id: String): Animal
}
```
Set your input, output paths and serviceName, then call buildCollection and exportCollection.
```js
import {GqlToTemplate} from 'graphql-schema-to-query'
new GqlToTemplate({
// Link to your source .gql or .graphql file
inputPath: "output/test.graphql",
// Link to folder where files will be saved
outputPath: "output",
// Name of your service, this is arbitrary but should not contain hyphens
serviceName: "BIRD_SERVICE",
// defaults to ["query", "queries", "mutation", "mutations"]
// searchTokens: []
})
.buildCollection()
.exportCollection({
// js or ts
extension: "ts",
// logs templates
debug: true
})
```
Produces the following files in the output folder
```
BIRD_SERVICE__bar.ts
BIRD_SERVICE__birdsWithFeathers.ts
BIRD_SERVICE__chicken.ts
BIRD_SERVICE__foo.ts
BIRD_SERVICE__getAnimals.ts
BIRD_SERVICE__parrot.ts
BIRD_SERVICE__updateBird.ts
```
with the following contents
```
export const template = `query BIRD_SERVICE____foo {foo }`
export const template = `query BIRD_SERVICE____bar {bar }`
export const template = `query BIRD_SERVICE__animals__birds__parrot {animals { birds { parrot } }}`
export const template = `query BIRD_SERVICE__animals__birds__chicken {animals { birds { chicken } }}`
export const template = `query BIRD_SERVICE__animals__birds__birdsWithFeathers {animals { birds { birdsWithFeathers {name species } } }}`
export const template = `query BIRD_SERVICE__animals__getAnimals($names: [String!]!) {animals { getAnimals(names: $names) {name species } }}`
export const template = `mutation BIRD_SERVICE____updateBird($id: String) {updateBird(id: $id) {name species }}`
```