closes #229 : Generate schema typings

Author: trioletas

README.md

@@ -22,8 +22,8 @@ Batteries included :raised_hands:
 - [GraphQL Models and Connectors architecture](https://dev-blog.apollodata.com/how-to-build-graphql-servers-87587591ded5) implementation
 - CORS middleware
 - [12 Factor Configuration](https://12factor.net/config) with `.env`
-- Configurable logging 
- - powered by `winston` 
+- Configurable logging
+ - powered by `winston`
 - Supercharged Development Mode
  - Incremental TypeScript builds
  - Automatic server restart on changes
@@ -56,6 +56,11 @@ or
 - Docker: `$ docker-compose up --build`
 
 Attention windows users: when `Docker for Windows` is not an option, install `yarn` and run `$ yarn && yarn docker-mount` beforehand.
+## Regenerate GraphQL schema TypeScript types
+
+- npm: `$ npm run g2t`
+- yarn: `$ yarn g2t`
+
 ## Test
 
 > single test run
@@ -109,12 +114,13 @@ In Docker:
  - [apollo-server](https://github.com/apollographql/apollo-server)
  - [graphql-voyager](https://apis.guru/graphql-voyager)
  - [graphql-playground](https://github.com/graphcool/graphql-playground)
+ - [graphql-to-typescript](https://github.com/3VLINC/graphql-to-typescript)
 
 - Jest
  - [Documentation](https://facebook.github.io/jest/docs/en/getting-started.html)
 
 - winston
  - [GitHub](https://github.com/winstonjs/winston)
- 
+
 - Docker
  - [Home Page](https://www.docker.com)

package.json

@@ -17,7 +17,8 @@
  "clean:graphql": "rimraf build/**/*.{gql,graphql,graphqls}",
  "copy:graphql": "cpx \"src/**/*.{gql,graphql,graphqls}\" build",
  "copy:graphql:watch": "chokidar \"./src/**/*.{gql,graphql,graphqls}\" -c \"npm run clean:graphql && npm run copy:graphql && touch src/server.ts\"",
- "docker-mount": "docker-share mount -t"
+ "docker-mount": "docker-share mount -t",
+ "g2t": "graphql-to-typescript src/graphql/*.graphqls src/graphql/types/index.ts "
  },
  "engines": {
  "node": ">= 8.1.4"
@@ -54,6 +55,7 @@
  "chokidar-cli": "1.2.0",
  "cpx": "1.5.0",
  "docker-share": "0.0.4",
+ "graphql-to-typescript": "0.1.2",
  "jest": "22.3.0",
  "jest-junit": "3.6.0",
  "nock": "9.1.6",

src/connectors/joke.ts

@@ -1,10 +1,10 @@
 import { createClient } from 'flashheart';
 import logger from '../logger';
-import { Joke, JokeCategoryValues } from '../graphql/types/jokes';
+import { JokeCategoryEnum } from '../graphql/types';
 
 const http = createClient({ logger });
 
-const getRandomJokeByCategory = async (category: JokeCategoryValues): Promise<any> => {
+const getRandomJokeByCategory = async (category: JokeCategoryEnum): Promise<any> => {
  const uri = `${process.env.JOKE_SERVICE_URL}/jokes/random${category ? `?limitTo=[${category.toLowerCase()}]` : ''}`;
 
  const { value } = await http.getAsync(uri);

src/graphql/models/jokes.ts

@@ -1,7 +1,7 @@
 import * as jokes from '../../connectors/joke';
-import { Joke, JokeCategoryValues } from '../../graphql/types/jokes';
+import { JokeCategoryEnum, Joke } from '../types';
 
-const byCategory = async (category: JokeCategoryValues): Promise<Joke> => {
+const byCategory = async (category: JokeCategoryEnum): Promise<Joke> => {
  const randomJokeResponse = await jokes.getRandomJokeByCategory(category);
  return {
  ...randomJokeResponse,

src/graphql/resolvers/jokes.ts

@@ -1,12 +1,12 @@
 import { byCategory } from '../models/jokes';
-import { Joke, JokeCategory } from '../types/jokes';
+import { ByCategoryJokesArgs, Joke } from '../types';
 
 const resolvers = {
  Query: {
  jokes: () => ({}),
  },
  Jokes: {
- byCategory: (_, { category }: JokeCategory): Promise<Joke> => byCategory(category),
+ byCategory: (_, { category }: ByCategoryJokesArgs): Promise<Joke> => byCategory(category!),
  },
 };
 

src/graphql/types/index.ts

@@ -0,0 +1,21 @@
+/* tslint:disable */
+
+export interface Query {
+ jokes: Jokes | null;
+}
+
+export interface Jokes {
+ byCategory: Joke | null;
+}
+
+export interface ByCategoryJokesArgs {
+ category: JokeCategoryEnum | null;
+}
+
+export type JokeCategoryEnum = "NERDY" | "EXPLICIT";
+
+export interface Joke {
+ id: string;
+ text: string;
+ categories: Array<JokeCategoryEnum> | null;
+}

src/graphql/types/jokes.ts

@@ -103,6 +103,10 @@
  version "0.12.4"
  resolved "https://registry.yarnpkg.com/@types/graphql/-/graphql-0.12.4.tgz#d43bb55d45c6de0178bbd11dd59d04fd42138d94"
 
+"@types/graphql@^0.8.5":
+ version "0.8.6"
+ resolved "https://registry.yarnpkg.com/@types/graphql/-/graphql-0.8.6.tgz#b34fb880493ba835b0c067024ee70130d6f9bb68"
+
 "@types/http-assert@*":
  version "1.2.2"
  resolved "https://registry.yarnpkg.com/@types/http-assert/-/http-assert-1.2.2.tgz#17dfe5a82184a8898935d96fe2eaedd37d22d9a4"
@@ -671,6 +675,13 @@ callsites@^2.0.0:
  version "2.0.0"
  resolved "https://registry.yarnpkg.com/callsites/-/callsites-2.0.0.tgz#06eb84f00eea413da86affefacbffb36093b3c50"
 
+camel-case@^3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/camel-case/-/camel-case-3.0.0.tgz#ca3c3688a4e9cf3a4cda777dc4dcbc713249cf73"
+ dependencies:
+ no-case "^2.2.0"
+ upper-case "^1.1.1"
+
 camelcase@^1.0.2:
  version "1.2.1"
  resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-1.2.1.tgz#9bb5304d2e0b56698b2c758b08a3eaa9daa58a39"
@@ -862,10 +873,20 @@ combined-stream@1.0.6, combined-stream@^1.0.5, combined-stream@~1.0.5:
  dependencies:
  delayed-stream "~1.0.0"
 
+commander@^2.10.0:
+ version "2.15.1"
+ resolved "https://registry.yarnpkg.com/commander/-/commander-2.15.1.tgz#df46e867d0fc2aec66a34662b406a9ccafff5b0f"
+
 commander@^2.9.0:
  version "2.14.1"
  resolved "https://registry.yarnpkg.com/commander/-/commander-2.14.1.tgz#2235123e37af8ca3c65df45b026dbd357b01b9aa"
 
+common-tags@^1.4.0:
+ version "1.7.2"
+ resolved "https://registry.yarnpkg.com/common-tags/-/common-tags-1.7.2.tgz#24d9768c63d253a56ecff93845b44b4df1d52771"
+ dependencies:
+ babel-runtime "^6.26.0"
+
 commonmark@^0.28.1:
  version "0.28.1"
  resolved "https://registry.yarnpkg.com/commonmark/-/commonmark-0.28.1.tgz#06eab8d52338b839fa1a2d75af0085eed1b1beae"
@@ -1181,6 +1202,10 @@ es-to-primitive@^1.1.1:
  is-date-object "^1.0.1"
  is-symbol "^1.0.1"
 
+es6-promise@^3.2.1:
+ version "3.3.1"
+ resolved "https://registry.yarnpkg.com/es6-promise/-/es6-promise-3.3.1.tgz#a08cdde84ccdbf34d027a1451bc91d4bcd28a613"
+
 escape-html@~1.0.1:
  version "1.0.3"
  resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"
@@ -1566,6 +1591,19 @@ graceful-fs@^4.1.11, graceful-fs@^4.1.2, graceful-fs@^4.1.6:
  version "4.1.11"
  resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
 
+graphql-code-generator@^0.5.1:
+ version "0.5.5"
+ resolved "https://registry.yarnpkg.com/graphql-code-generator/-/graphql-code-generator-0.5.5.tgz#ad2a3ab2ffae56faf0290f0317dd515213f598e5"
+ dependencies:
+ camel-case "^3.0.0"
+ commander "^2.10.0"
+ common-tags "^1.4.0"
+ glob "^7.1.2"
+ handlebars "^4.0.10"
+ mkdirp "^0.5.1"
+ pascal-case "^2.0.1"
+ request "^2.81.0"
+
 graphql-config@1.1.7:
  version "1.1.7"
  resolved "https://registry.yarnpkg.com/graphql-config/-/graphql-config-1.1.7.tgz#546c443d3ad877ceb8e13f40fbc8937af0d35dbe"
@@ -1609,6 +1647,23 @@ graphql-request@^1.3.6, graphql-request@^1.4.0:
  dependencies:
  cross-fetch "1.1.1"
 
+graphql-subscriptions@^0.3.1:
+ version "0.3.1"
+ resolved "https://registry.yarnpkg.com/graphql-subscriptions/-/graphql-subscriptions-0.3.1.tgz#0cedc2d507420cf26cf414080b079f05402f0303"
+ dependencies:
+ es6-promise "^3.2.1"
+
+graphql-to-typescript@0.1.2:
+ version "0.1.2"
+ resolved "https://registry.yarnpkg.com/graphql-to-typescript/-/graphql-to-typescript-0.1.2.tgz#a5a3ba625216c7408f13e5c62724f9973f42909b"
+ dependencies:
+ chalk "^1.1.3"
+ commander "^2.9.0"
+ graphql "^0.9.1"
+ graphql-code-generator "^0.5.1"
+ graphql-subscriptions "^0.3.1"
+ graphql-tools "^0.10.1"
+
 graphql-tools@2.21.0:
  version "2.21.0"
  resolved "https://registry.yarnpkg.com/graphql-tools/-/graphql-tools-2.21.0.tgz#c0d0fbda6f40a87c8d267a2989ade2ae8b9a288e"
@@ -1619,6 +1674,16 @@ graphql-tools@2.21.0:
  iterall "^1.1.3"
  uuid "^3.1.0"
 
+graphql-tools@^0.10.1:
+ version "0.10.1"
+ resolved "https://registry.yarnpkg.com/graphql-tools/-/graphql-tools-0.10.1.tgz#274aa338d50b1c0b3ed6936eafd8ed3a19ed1828"
+ dependencies:
+ deprecated-decorator "^0.1.6"
+ lodash "^4.3.0"
+ uuid "^3.0.1"
+ optionalDependencies:
+ "@types/graphql" "^0.8.5"
+
 graphql-voyager@1.0.0-rc.11:
  version "1.0.0-rc.11"
  resolved "https://registry.yarnpkg.com/graphql-voyager/-/graphql-voyager-1.0.0-rc.11.tgz#5cc348e507062d4ef8540cead25dc2cec04ef933"
@@ -1650,11 +1715,17 @@ graphql@^0.12.3:
  dependencies:
  iterall "1.1.3"
 
+graphql@^0.9.1:
+ version "0.9.6"
+ resolved "https://registry.yarnpkg.com/graphql/-/graphql-0.9.6.tgz#514421e9d225c29dfc8fd305459abae58815ef2c"
+ dependencies:
+ iterall "^1.0.0"
+
 growly@^1.3.0:
  version "1.3.0"
  resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
 
-handlebars@^4.0.3:
+handlebars@^4.0.10, handlebars@^4.0.3:
  version "4.0.11"
  resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.0.11.tgz#630a35dfe0294bc281edae6ffc5d329fc7982dcc"
  dependencies:
@@ -2109,6 +2180,10 @@ iterall@1.1.3:
  version "1.1.3"
  resolved "https://registry.yarnpkg.com/iterall/-/iterall-1.1.3.tgz#1cbbff96204056dde6656e2ed2e2226d0e6d72c9"
 
+iterall@^1.0.0:
+ version "1.2.2"
+ resolved "https://registry.yarnpkg.com/iterall/-/iterall-1.2.2.tgz#92d70deb8028e0c39ff3164fdbf4d8b088130cd7"
+
 iterall@^1.1.3, iterall@^1.2.0:
  version "1.2.0"
  resolved "https://registry.yarnpkg.com/iterall/-/iterall-1.2.0.tgz#434e9f41f0b99911ab9c3d49d95f0e079176a2a2"
@@ -2638,7 +2713,7 @@ lodash.sortby@^4.7.0:
  version "4.7.0"
  resolved "https://registry.yarnpkg.com/lodash.sortby/-/lodash.sortby-4.7.0.tgz#edd14c824e2cc9c1e0b0a1b42bb5210516a42438"
 
-lodash@4.17.5, lodash@^4.0.0, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.17.2, lodash@^4.17.4, lodash@^4.17.5, lodash@^4.2.0, lodash@^4.2.1, lodash@^4.5.1, lodash@~4.17.2:
+lodash@4.17.5, lodash@^4.0.0, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.17.2, lodash@^4.17.4, lodash@^4.17.5, lodash@^4.2.0, lodash@^4.2.1, lodash@^4.3.0, lodash@^4.5.1, lodash@~4.17.2:
  version "4.17.5"
  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511"
 
@@ -2663,6 +2738,10 @@ loose-envify@^1.0.0, loose-envify@^1.1.0, loose-envify@^1.3.1:
  dependencies:
  js-tokens "^3.0.0"
 
+lower-case@^1.1.1:
+ version "1.1.4"
+ resolved "https://registry.yarnpkg.com/lower-case/-/lower-case-1.1.4.tgz#9a2cabd1b9e8e0ae993a4bf7d5875c39c42e8eac"
+
 lru-cache@^4.0.1:
  version "4.1.1"
  resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.1.1.tgz#622e32e82488b49279114a4f9ecf45e7cd6bba55"
@@ -2800,6 +2879,12 @@ negotiator@0.6.1:
  version "0.6.1"
  resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.1.tgz#2b327184e8992101177b28563fb5e7102acd0ca9"
 
+no-case@^2.2.0:
+ version "2.3.2"
+ resolved "https://registry.yarnpkg.com/no-case/-/no-case-2.3.2.tgz#60b813396be39b3f1288a4c1ed5d1e7d28b464ac"
+ dependencies:
+ lower-case "^1.1.1"
+
 nock@9.1.6:
  version "9.1.6"
  resolved "https://registry.yarnpkg.com/nock/-/nock-9.1.6.tgz#16395af4c45b0fd84d1a4a9668154e16fa6624db"
@@ -3060,6 +3145,13 @@ parseurl@^1.3.0:
  version "1.3.2"
  resolved "https://registry.yarnpkg.com/parseurl/-/parseurl-1.3.2.tgz#fc289d4ed8993119460c156253262cdc8de65bf3"
 
+pascal-case@^2.0.1:
+ version "2.0.1"
+ resolved "https://registry.yarnpkg.com/pascal-case/-/pascal-case-2.0.1.tgz#2d578d3455f660da65eca18ef95b4e0de912761e"
+ dependencies:
+ camel-case "^3.0.0"
+ upper-case-first "^1.1.0"
+
 path-exists@^2.0.0:
  version "2.1.0"
  resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-2.1.0.tgz#0feb6c64f0fc518d9a754dd5efb62c7022761f4b"
@@ -3465,6 +3557,33 @@ request@2.81.0:
  tunnel-agent "^0.6.0"
  uuid "^3.0.0"
 
+request@^2.81.0:
+ version "2.85.0"
+ resolved "https://registry.yarnpkg.com/request/-/request-2.85.0.tgz#5a03615a47c61420b3eb99b7dba204f83603e1fa"
+ dependencies:
+ aws-sign2 "~0.7.0"
+ aws4 "^1.6.0"
+ caseless "~0.12.0"
+ combined-stream "~1.0.5"
+ extend "~3.0.1"
+ forever-agent "~0.6.1"
+ form-data "~2.3.1"
+ har-validator "~5.0.3"
+ hawk "~6.0.2"
+ http-signature "~1.2.0"
+ is-typedarray "~1.0.0"
+ isstream "~0.1.2"
+ json-stringify-safe "~5.0.1"
+ mime-types "~2.1.17"
+ oauth-sign "~0.8.2"
+ performance-now "^2.1.0"
+ qs "~6.5.1"
+ safe-buffer "^5.1.1"
+ stringstream "~0.0.5"
+ tough-cookie "~2.3.3"
+ tunnel-agent "^0.6.0"
+ uuid "^3.1.0"
+
 request@^2.83.0:
  version "2.83.0"
  resolved "https://registry.yarnpkg.com/request/-/request-2.83.0.tgz#ca0b65da02ed62935887808e6f510381034e3356"
@@ -4082,6 +4201,16 @@ unpipe@1.0.0:
  version "1.0.0"
  resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec"
 
+upper-case-first@^1.1.0:
+ version "1.1.2"
+ resolved "https://registry.yarnpkg.com/upper-case-first/-/upper-case-first-1.1.2.tgz#5d79bedcff14419518fd2edb0a0507c9b6859115"
+ dependencies:
+ upper-case "^1.1.1"
+
+upper-case@^1.1.1:
+ version "1.1.3"
+ resolved "https://registry.yarnpkg.com/upper-case/-/upper-case-1.1.3.tgz#f6b4501c2ec4cdd26ba78be7222961de77621598"
+
 urijs@^1.19.0:
  version "1.19.1"
  resolved "https://registry.yarnpkg.com/urijs/-/urijs-1.19.1.tgz#5b0ff530c0cbde8386f6342235ba5ca6e995d25a"
@@ -4097,7 +4226,7 @@ util.promisify@^1.0.0:
  define-properties "^1.1.2"
  object.getownpropertydescriptors "^2.0.3"
 
-uuid@^3.0.0, uuid@^3.1.0:
+uuid@^3.0.0, uuid@^3.0.1, uuid@^3.1.0:
  version "3.2.1"
  resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.2.1.tgz#12c528bb9d58d0b9265d9a2f6f0fe8be17ff1f14"