You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-8
Original file line number
Diff line number
Diff line change
@@ -164,15 +164,15 @@ See packages/graphql-codegen-hasura-core/src/utils.test.ts for example usage
164
164
165
165
- See [ApolloGraphQL Documentation](https://www.apollographql.com/docs/react/) for specifics on the underlying client operations
166
166
- See [ApolloGraphQL Documentation](https://www.apollographql.com/docs/react/) for specifics on the underlying backend operations
167
-
- See below and [demo project](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for further details
167
+
- See below and [demo project](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for further details
168
168
169
169
## Apollo Version
170
170
171
171
Please note, this library currently only supports version 3 of the React Apollo client
172
172
173
173
## Quick Start
174
174
175
-
To quickly view the type of code that gets generated, view the [autogen code files in the demo project](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura).
175
+
To quickly view the type of code that gets generated, view the [autogen code files in the demo project](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura).
176
176
177
177
To quickly try out the code-generation:
178
178
@@ -210,7 +210,7 @@ The easiest way to quickly get going is to view the following files in the demo
- **Output**: See [generated code in demo](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) and [See plugin details section below](#plugin-details).
213
+
- **Output**: See [generated code in demo](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) and [See plugin details section below](#plugin-details).
214
214
215
215
It is **important to note**: The TypeScript Generation leverages the files created in the GQL generation step. As such, **it is important to run the GQL generation step prior to the TypeScript generation step**.
216
216
@@ -294,31 +294,31 @@ See [graphql-code-generator documentation](https://graphql-code-generator.com/do
294
294
295
295
Generates [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) gql mutations and queries for every _Fragment_ defined in the targeted (code) documents.
296
296
297
-
See [demo/src/autogen/hasura/gql.ts](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
297
+
See [demo/src/autogen/hasura/gql.ts](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
298
298
299
299
### graphql-codegen-hasura-typescript plugin
300
300
301
301
#### Overview
302
302
303
303
Generates [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) TypeScript helper methods for every _Fragment_ defined in the targeted (code) documents. Provides wrapped client.query & client.mutate calls, in addition to adding some convenience features.
304
304
305
-
See [demo/src/autogen/hasura/ts.ts](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
305
+
See [demo/src/autogen/hasura/ts.ts](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
306
306
307
307
### graphql-codegen-hasura-react plugin
308
308
309
309
#### Overview
310
310
311
311
Generates [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) React Hooks for every _Fragment_ defined in the targeted (code) documents.
312
312
313
-
See [demo/src/autogen/hasura/ts-react.ts](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
313
+
See [demo/src/autogen/hasura/ts-react.ts](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
314
314
315
315
### graphql-codegen-hasura-client-config plugin
316
316
317
317
#### Overview
318
318
319
319
Generates TypeScript Type Policies and Resolver Types for tables related to GQL fragments found in the targeted documents (code).
320
320
321
-
See [demo/src/autogen/hasura/ts-config.ts](https://github.com/ahrnee/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
321
+
See [demo/src/autogen/hasura/ts-config.ts](https://github.com/jamshally/graphql-codegen-hasura/tree/master/demo/src/autogen/hasura) for generated output files.
322
322
323
323
## Naming Conventions
324
324
@@ -344,6 +344,10 @@ The demo project is simply:
344
344
345
345
The consistency and predictability of the [Hasura](https://hasura.io/) GQL backend implementation, provides an opportunity to automate much of the remaining code for standard single-table mutations and queries, and multi-table helper code. These plugins are designed to provide this.
346
346
347
+
## Related/Companion Libraries
348
+
349
+
TBD
350
+
347
351
## Disclaimers & Known Issues
348
352
349
353
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project.
@@ -367,7 +371,7 @@ There are many refinements and enhancements that would be beneficial, and contri
367
371
368
372
## Help Wanted
369
373
370
-
- \*The main issue with [Refinements Needed](##Refinements-and-Enhancements-Needed) item 1 (above) is how to determine a primary key from a GQL schema (and FieldDefinitionNodes). Currently the code relies on the name of the primary key field being `id`. If anyone knows how to identify a primary key field from the GQL schema, let me know, or submit a pull request with the fix. The relevant section of code is [here](https://github.com/ahrnee/graphql-codegen-hasura/blob/fbbb449ad5e4155dbc0b2cc7955712695d7d86a8/packages/graphql-codegen-hasura-shared/src/utils.ts#L78).
374
+
- \*The main issue with [Refinements Needed](##Refinements-and-Enhancements-Needed) item 1 (above) is how to determine a primary key from a GQL schema (and FieldDefinitionNodes). Currently the code relies on the name of the primary key field being `id`. If anyone knows how to identify a primary key field from the GQL schema, let me know, or submit a pull request with the fix. The relevant section of code is [here](https://github.com/jamshally/graphql-codegen-hasura/blob/fbbb449ad5e4155dbc0b2cc7955712695d7d86a8/packages/graphql-codegen-hasura-shared/src/utils.ts#L78).
371
375
- \*\* Contributions to [Refinements Needed](##Refinements-and-Enhancements-Needed) item 7 (above) would be welcome. This would unlock powerful additional codegen capabilities at a field level (currently limited to table level). Familiarity with the Visitor pattern (or willingness to learn it) is a prerequisite.
Copy file name to clipboardExpand all lines: packages/graphql-codegen-hasura-client-config/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ graphql-codegen-hasura-client-config-documents is a code generator plugin for [g
8
8
9
9
## Instructions
10
10
11
-
See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for usage and configuration information.
11
+
See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for usage and configuration information.
12
12
13
13
## Motivation
14
14
@@ -18,7 +18,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
18
18
19
19
## Disclaimers
20
20
21
-
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for additional information.
21
+
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for additional information.
Copy file name to clipboardExpand all lines: packages/graphql-codegen-hasura-core/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
## Summary
4
4
5
-
This package contains core Types and supporting functions for the code generated by the suite of [graphql-codegen-hasura tools](https://github.com/ahrnee/graphql-codegen-hasura)
5
+
This package contains core Types and supporting functions for the code generated by the suite of [graphql-codegen-hasura tools](https://github.com/jamshally/graphql-codegen-hasura)
6
6
7
7
## Instructions
8
8
9
-
This package should be referenced in the dependencies of the package.json of code consuming the [graphql-codegen-hasura](https://github.com/ahrnee/graphql-codegen-hasura) generated code
9
+
This package should be referenced in the dependencies of the package.json of code consuming the [graphql-codegen-hasura](https://github.com/jamshally/graphql-codegen-hasura) generated code
10
10
11
11
## Motivation
12
12
@@ -16,7 +16,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
16
16
17
17
## Disclaimers & Futher Information
18
18
19
-
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for additional information.
19
+
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for additional information.
Copy file name to clipboardExpand all lines: packages/graphql-codegen-hasura-core/dist/src/README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
## Summary
4
4
5
-
This package contains core Types and supporting functions for the code generated by the suite of [graphql-codegen-hasura tools](https://github.com/ahrnee/graphql-codegen-hasura)
5
+
This package contains core Types and supporting functions for the code generated by the suite of [graphql-codegen-hasura tools](https://github.com/jamshally/graphql-codegen-hasura)
6
6
7
7
## Instructions
8
8
9
-
This package should be referenced in the dependencies of the package.json of code consuming the [graphql-codegen-hasura](https://github.com/ahrnee/graphql-codegen-hasura) generated code
9
+
This package should be referenced in the dependencies of the package.json of code consuming the [graphql-codegen-hasura](https://github.com/jamshally/graphql-codegen-hasura) generated code
10
10
11
11
## Motivation
12
12
@@ -16,7 +16,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
16
16
17
17
## Disclaimers & Futher Information
18
18
19
-
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for additional information.
19
+
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for additional information.
Copy file name to clipboardExpand all lines: packages/graphql-codegen-hasura-gql/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ graphql-codegen-hasura-gql is a code generator plugin for [graphql-code-generato
8
8
9
9
## Instructions
10
10
11
-
See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for usage and configuration information.
11
+
See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for usage and configuration information.
12
12
13
13
## Motivation
14
14
@@ -18,7 +18,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
18
18
19
19
## Disclaimers
20
20
21
-
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for additional information.
21
+
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for additional information.
Copy file name to clipboardExpand all lines: packages/graphql-codegen-hasura-react/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ graphql-codegen-hasura-react-documents is a code generator plugin for [graphql-c
8
8
9
9
## Instructions
10
10
11
-
See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for usage and configuration information.
11
+
See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for usage and configuration information.
12
12
13
13
## Motivation
14
14
@@ -18,7 +18,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
18
18
19
19
## Disclaimers
20
20
21
-
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/ahrnee/graphql-codegen-hasura) for additional information.
21
+
This code was initially developed for use in a single separate commercial project. It is being shared in case useful to others, and as a contribution to the development community and the great GraphQL tools that already exist. The original implementation did just enough to meet the goals and needs of the initial project. There are many refinements and enhancements that would be beneficial - and contributions to that end are encouraged. See the associated [graphql-codegen-hasura GitHub repo](https://github.com/jamshally/graphql-codegen-hasura) for additional information.
0 commit comments