Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielogregorio/ts-to-gql
📦 Generate graphql types from your typescript code. NEEDS REFACTOR
https://github.com/gabrielogregorio/ts-to-gql
generator gql graphql lib node-js npm-package ts typescript
Last synced: 6 days ago
JSON representation
📦 Generate graphql types from your typescript code. NEEDS REFACTOR
- Host: GitHub
- URL: https://github.com/gabrielogregorio/ts-to-gql
- Owner: gabrielogregorio
- Created: 2023-01-28T18:08:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-01T12:04:29.000Z (over 1 year ago)
- Last Synced: 2024-11-07T20:51:24.459Z (11 days ago)
- Topics: generator, gql, graphql, lib, node-js, npm-package, ts, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ts-to-gql
- Size: 1.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# TS to GQL - **BETA PROJECT**
## Introduction
Generate graphql types based on your typescript types. DO NOT ADD the schema generated in .gitignore. Schemas are generated at development time and versioned!
💻 🚀 [Api example here](https://github.com/gabrielogregorio/ts-to-gql-example) 🚀 💻
[](https://www.codacy.com/gh/gabrielogregorio/ts-to-gql/dashboard?utm_source=github.com&utm_medium=referral&utm_content=gabrielogregorio/ts-to-gql&utm_campaign=Badge_Grade) [](https://www.codacy.com/gh/gabrielogregorio/ts-to-gql/dashboard?utm_source=github.com&utm_medium=referral&utm_content=gabrielogregorio/ts-to-gql&utm_campaign=Badge_Coverage)
### Example
```ts
// ./src/models/post.ts
export type GqlModelPostSelect = {
id: string;
body?: string;
};
// ./src/graphql/resolvers/mutations/post.ts
import { GqlModelPostSelect } from '@/models/Post';
interface CreatePostPayload {
createPostPayload: {
body: string;
};
}
type GqlMutationPost = {
createPost: (
_: unknown,
createPostPayload: CreatePostPayload
) => Promise;
};
export const MutationPostResolver: GqlMutationPost = {
// code resolvers
}
```
configure ts-to-gql
```ts
import { searchGqlSchemaAndBuild } from 'ts-to-gql';
const typeDefs = searchGqlSchemaAndBuild({
isProduction: false,
pathScanProject: './src',
});
this.server = new ApolloServer({
resolvers,
typeDefs,
});
```
And magic, your types in graphql
```gql
type PostSelect {
id: String!
body: String
};
interface CreatePostPayload {
createPostPayload: {
body: string;
};
}
type Mutation {
createPost(createPostPayload: CreatePostPayload): PostSelect!
}
```
## Options searchGqlSchemaAndBuild
| command | example | description |
|---------|----------|--------------|
| (required) isProduction | true or false |
true will use the generated and versioned schema in the source code. false, it will generate a new schema every hot reload (or reload) of your application. |
| (required) pathScanProject | './src' | path to search models, queries and mutations |
| pathSaveSchema | './schema.graphql' | path to save schema |
| prefixModel | 'Model' or 'GqlModel' for example | prefix to search models |
| prefixMutation | 'Mutation' or 'GqlMutation' for example | prefix to search mutations |
| prefixQuery | 'Query' or 'GqlQuery' for example | prefix to find queries |
| removePrefixFromSchema | true or false | if true, remove prefix schema in final schema |
| fixSchema | (schemaGql: string): string => schemaGql | function to fix schema, add new values or modify existents. Use to add things the library doesn't support for now |
## Special types
if necessary use Float, Int, ID or similar, import special types from 'ts-to-gql'. Typescript types like string, number, boolean are automatically converted to String, Number and Boolean respectively.
```ts
import { Int, ID, DateTime, Float } from 'ts-to-gql';
```
Int, Float is string, DateTime is Date, and ID is string
## Common errors on migration
Migration is manual, for now.
1. Not use Partial, extends, implements, or advanced typescript. for now
2. use types, not interfaces (for now)
3. ts-to-gql use only second param, define first param or contexts for example
```ts
type MutationPost = {
createPost: (input: CreatePost) => Promise;
}
```
to
```ts
type MutationPost = {
createPost: (_: unknown, input: CreatePost) => Promise;
}
```
--------
4. replace your resolver to arrow types, this
```ts
type MutationPost = {
createPost(_: unknown, input: CreatePost): Promise;
}
```
to
```ts
type MutationPost = {
createPost: (_: unknown, input: CreatePost) => Promise;
}
```
5. use prefix, for ts-to-gql find your models, queries and mutations (other not necessary)
```ts
type MyPost = {}
```
to
```ts
type MutationMyPost = {}
```