Skip to content

Commit 8dbf45d

Browse files
committed
Consolidating and updating associated account
1 parent d324758 commit 8dbf45d

File tree

20 files changed

+57
-5191
lines changed

20 files changed

+57
-5191
lines changed

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Ahrnee
3+
Copyright (c) 2020 Shallyware
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Diff for: README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -164,15 +164,15 @@ See packages/graphql-codegen-hasura-core/src/utils.test.ts for example usage
164164
165165
- See [ApolloGraphQL Documentation](https://www.apollographql.com/docs/react/) for specifics on the underlying client operations
166166
- 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
168168
169169
## Apollo Version
170170
171171
Please note, this library currently only supports version 3 of the React Apollo client
172172
173173
## Quick Start
174174
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).
176176
177177
To quickly try out the code-generation:
178178
@@ -210,7 +210,7 @@ The easiest way to quickly get going is to view the following files in the demo
210210
211211
- **Gql Generation Config**: `demo/graphql-codegen-gql.yaml`
212212
- **TypesScript Generation Config**: `demo/graphql-codegen-typescript.yaml`
213-
- **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).
214214
215215
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**.
216216
@@ -294,31 +294,31 @@ See [graphql-code-generator documentation](https://graphql-code-generator.com/do
294294
295295
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.
296296
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.
298298
299299
### graphql-codegen-hasura-typescript plugin
300300
301301
#### Overview
302302
303303
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.
304304
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.
306306
307307
### graphql-codegen-hasura-react plugin
308308
309309
#### Overview
310310
311311
Generates [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) React Hooks for every _Fragment_ defined in the targeted (code) documents.
312312
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.
314314
315315
### graphql-codegen-hasura-client-config plugin
316316
317317
#### Overview
318318
319319
Generates TypeScript Type Policies and Resolver Types for tables related to GQL fragments found in the targeted documents (code).
320320
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.
322322
323323
## Naming Conventions
324324
@@ -344,6 +344,10 @@ The demo project is simply:
344344
345345
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.
346346
347+
## Related/Companion Libraries
348+
349+
TBD
350+
347351
## Disclaimers & Known Issues
348352
349353
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
367371
368372
## Help Wanted
369373
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).
371375
- \*\* 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.
372376
373377
## Notes

Diff for: package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
"name": "graphql-codegen-hasura",
44
"version": "4.9.0",
55
"description": "A collection of codgen plugins to support Hasura/Apollo GraphQL development",
6-
"author": "ahrnee",
6+
"author": "jamshally",
77
"license": "MIT",
88
"repository": {
99
"type": "git",
10-
"url": "git+https://github.com/ahrnee/graphql-codegen-hasura"
10+
"url": "git+https://github.com/jamshally/graphql-codegen-hasura"
1111
},
1212
"scripts": {
1313
"bootstrap": "lerna bootstrap",

Diff for: packages/graphql-codegen-hasura-client-config/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ graphql-codegen-hasura-client-config-documents is a code generator plugin for [g
88

99
## Instructions
1010

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.
1212

1313
## Motivation
1414

@@ -18,7 +18,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
1818

1919
## Disclaimers
2020

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.
2222

2323
## Note
2424

Diff for: packages/graphql-codegen-hasura-client-config/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
"name": "graphql-codegen-hasura-client-config",
33
"version": "4.9.0",
44
"description": "GraphQL Code Generator plugin for generating a CRUD TypeScript Config for Hasura from Documents",
5-
"author": "ahrnee <[email protected]>",
5+
"author": "jamshally <[email protected]>",
66
"license": "MIT",
7-
"homepage": "https://github.com/ahrnee/graphql-codegen-hasura",
7+
"homepage": "https://github.com/jamshally/graphql-codegen-hasura",
88
"repository": {
99
"type": "git",
10-
"url": "git+https://github.com/ahrnee/graphql-codegen-hasura"
10+
"url": "git+https://github.com/jamshally/graphql-codegen-hasura"
1111
},
1212
"scripts": {
1313
"prepublishOnly": "rm -f dist/src/package.json dist/src/README.md && cp package.json README.md dist/src/"

Diff for: packages/graphql-codegen-hasura-core/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Summary
44

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)
66

77
## Instructions
88

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
1010

1111
## Motivation
1212

@@ -16,7 +16,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
1616

1717
## Disclaimers & Futher Information
1818

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.
2020

2121
## Note
2222

Diff for: packages/graphql-codegen-hasura-core/dist/src/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Summary
44

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)
66

77
## Instructions
88

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
1010

1111
## Motivation
1212

@@ -16,7 +16,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
1616

1717
## Disclaimers & Futher Information
1818

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.
2020

2121
## Note
2222

Diff for: packages/graphql-codegen-hasura-core/dist/src/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
"name": "graphql-codegen-hasura-core",
33
"version": "4.9.0",
44
"description": "GraphQL Code Generator plugin for generating a CRUD TypeScript Config for Hasura from Documents",
5-
"author": "ahrnee <[email protected]>",
5+
"author": "jamshally <[email protected]>",
66
"license": "MIT",
7-
"homepage": "https://github.com/ahrnee/graphql-codegen-hasura",
7+
"homepage": "https://github.com/jamshally/graphql-codegen-hasura",
88
"repository": {
99
"type": "git",
10-
"url": "git+https://github.com/ahrnee/graphql-codegen-hasura"
10+
"url": "git+https://github.com/jamshally/graphql-codegen-hasura"
1111
},
1212
"scripts": {
1313
"prepublishOnly": "rm -f dist/src/package.json dist/src/README.md && cp package.json README.md dist/src/",

Diff for: packages/graphql-codegen-hasura-core/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
"name": "graphql-codegen-hasura-core",
33
"version": "4.9.0",
44
"description": "GraphQL Code Generator plugin for generating a CRUD TypeScript Config for Hasura from Documents",
5-
"author": "ahrnee <[email protected]>",
5+
"author": "jamshally <[email protected]>",
66
"license": "MIT",
7-
"homepage": "https://github.com/ahrnee/graphql-codegen-hasura",
7+
"homepage": "https://github.com/jamshally/graphql-codegen-hasura",
88
"repository": {
99
"type": "git",
10-
"url": "git+https://github.com/ahrnee/graphql-codegen-hasura"
10+
"url": "git+https://github.com/jamshally/graphql-codegen-hasura"
1111
},
1212
"scripts": {
1313
"prepublishOnly": "rm -f dist/src/package.json dist/src/README.md && cp package.json README.md dist/src/",

Diff for: packages/graphql-codegen-hasura-gql/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ graphql-codegen-hasura-gql is a code generator plugin for [graphql-code-generato
88

99
## Instructions
1010

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.
1212

1313
## Motivation
1414

@@ -18,7 +18,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
1818

1919
## Disclaimers
2020

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.
2222

2323
## Note
2424

Diff for: packages/graphql-codegen-hasura-gql/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
"name": "graphql-codegen-hasura-gql",
33
"version": "4.9.0",
44
"description": "GraphQL Code Generator plugin for generating a CRUD Gql for Hasura",
5-
"author": "ahrnee <[email protected]>",
5+
"author": "jamshally <[email protected]>",
66
"license": "MIT",
7-
"homepage": "https://github.com/ahrnee/graphql-codegen-hasura",
7+
"homepage": "https://github.com/jamshally/graphql-codegen-hasura",
88
"repository": {
99
"type": "git",
10-
"url": "git+https://github.com/ahrnee/graphql-codegen-hasura"
10+
"url": "git+https://github.com/jamshally/graphql-codegen-hasura"
1111
},
1212
"scripts": {
1313
"prepublishOnly": "rm -f dist/src/package.json dist/src/README.md && cp package.json README.md dist/src/"

Diff for: packages/graphql-codegen-hasura-react/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ graphql-codegen-hasura-react-documents is a code generator plugin for [graphql-c
88

99
## Instructions
1010

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.
1212

1313
## Motivation
1414

@@ -18,7 +18,7 @@ The consistency and predictability of the Hasura](https://hasura.io/) GQL backen
1818

1919
## Disclaimers
2020

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.
2222

2323
## Note
2424

0 commit comments

Comments
 (0)