Merge branch 'jeniffer9-master'

dupski · dupski · commit 55c11b591bea · 2018-09-27T19:36:16.000+12:00
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ Supported Options:
  * Support for Enum values via [`EnumType`](#query-with-enum-values)
  * Support for variables via [`__variables`](#query-with-variables)
  * Support for simple directives (such as `@client`) via [`__directives`](#query-with-directives)
+ * Support for inline fragments via [`__on.__fragmentName`](#query-with-inline-fragments)
 
 ## Recent Changes
 
@@ -341,6 +342,75 @@ query {
 }
 ```
 
+### Query with Inline Fragments
+
+```typescript
+import { jsonToGraphQLQuery } from 'json-to-graphql-query';
+
+const query = {
+    query: {
+        Posts: {
+            title: true
+            __on: {
+                __fragmentName: "ConfigurablePost",
+                id: true
+            }
+        }
+    }
+};
+const graphql_query = jsonToGraphQLQuery(query, { pretty: true });
+```
+
+Resulting `graphql_query`
+
+```graphql
+query {
+    Posts {
+        title
+        ... on ConfigurablePost {
+            id
+        }
+    }
+}
+```
+
+### Query with multiple Inline Fragments
+```typescript
+import { jsonToGraphQLQuery } from 'json-to-graphql-query';
+
+const query = {
+            query: {
+                Posts: {
+                    __on: [
+                    {
+                        __fragmentName: "ConfigurablePost",
+                        id: true
+                    },
+                    {
+                        __fragmentName: "UnconfigurablePost",
+                        name: true
+                    }]
+                }
+            }
+        };
+const graphql_query = jsonToGraphQLQuery(query, { pretty: true });
+```
+Resulting `graphql_query`
+
+```graphql
+query {
+    Posts {
+        title
+        ... on ConfigurablePost {
+            id
+        }
+        ... on UnconfigurablePost {
+            name
+        }
+    }
+}
+```
+
 ## TO-DO List
 
  * Support Named Queries / Mutations
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "json-to-graphql-query",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "main": "lib/index.js",
   "license": "MIT",
   "scripts": {
diff --git a/src/__tests__/jsonToGraphQLQuery.tests.ts b/src/__tests__/jsonToGraphQLQuery.tests.ts
@@ -33,7 +33,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts {
         id
         title
@@ -57,7 +57,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts (orderBy: "post_date", userId: 12) {
         id
         title
@@ -84,7 +84,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts (where: {published: true, rating: {_gt: 3}}, orderBy: "post_date") {
         id
         title
@@ -111,7 +111,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts (or: [{published: true}, {rating: [{_gt: 3}]}], orderBy: "post_date") {
         id
         title
@@ -137,7 +137,7 @@ describe('jsonToGraphQL()', () => {
             }
         } as any;
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts (where: {id: null}, orderBy: null) {
         id
         title
@@ -166,7 +166,7 @@ describe('jsonToGraphQL()', () => {
             }
         } as any;
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts @client (where: {id: 10}, orderBy: "flibble") {
         id
         title
@@ -209,8 +209,8 @@ describe('jsonToGraphQL()', () => {
             }
         };
         const expected = 'query { diet @client { id options { ' +
-        'mood { category id selected } weight { category icon id text } } ' +
-        'title } someOtherAbritraryKey @client { arb1 arb2 } }';
+            'mood { category id selected } weight { category icon id text } } ' +
+            'title } someOtherAbritraryKey @client { arb1 arb2 } }';
         expect(jsonToGraphQLQuery(query)).to.equal(expected);
     });
 
@@ -260,7 +260,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts {
         id
         title
@@ -295,7 +295,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`query {
+            `query {
     Posts (arg1: 20, arg2: "flibble") {
         id
         title
@@ -320,7 +320,7 @@ describe('jsonToGraphQL()', () => {
             }
         };
         expect(jsonToGraphQLQuery(query, { pretty: true })).to.equal(
-`mutation {
+            `mutation {
     create_post (title: "My Awesome Post", body: "This post is awesome!")
 }`);
     });
@@ -385,24 +385,24 @@ describe('jsonToGraphQL()', () => {
     });
 
     it('does not include fields which value is false', () => {
-      const query = {
-        query: {
-            Posts: {
-                __args: {
-                  a: false
+        const query = {
+            query: {
+                Posts: {
+                    __args: {
+                        a: false
+                    },
+                    id: true,
+                    name: false
                 },
-                id: true,
-                name: false
-            },
-            Lorem: {
-              id: true
-            },
-            Ipsum: false
-        }
-      };
-      expect(jsonToGraphQLQuery(query)).to.equal(
-        'query { Posts (a: false) { id } Lorem { id } }'
-      );
+                Lorem: {
+                    id: true
+                },
+                Ipsum: false
+            }
+        };
+        expect(jsonToGraphQLQuery(query)).to.equal(
+            'query { Posts (a: false) { id } Lorem { id } }'
+        );
     });
 
     it('ignores a field that exists in the initial object', () => {
@@ -431,6 +431,60 @@ describe('jsonToGraphQL()', () => {
 }`);
     });
 
+    it('supports inline fragments', () => {
+        const query = {
+            query: {
+                Posts: {
+                    __on: {
+                        __fragmentName: 'ConfigurablePost',
+                        id: true
+                    }
+                }
+            }
+        };
+        expect(jsonToGraphQLQuery(query)).to.equal(
+            'query { Posts { ... on ConfigurablePost { id } } }'
+        );
+    });
+
+    it('supports inline fragments with subfields on same level', () => {
+        const query = {
+            query: {
+                Posts: {
+                    title: true,
+                    __on: {
+                        __fragmentName: 'ConfigurablePost',
+                        id: true
+                    }
+                }
+            }
+        };
+        expect(jsonToGraphQLQuery(query)).to.equal(
+            'query { Posts { title ... on ConfigurablePost { id } } }'
+        );
+    });
+
+    it('supports multiple inline fragments', () => {
+        const query = {
+            query: {
+                Posts: {
+                    __on: [
+                        {
+                            __fragmentName: 'ConfigurablePost',
+                            id: true
+                        },
+                        {
+                            __fragmentName: 'UnconfigurablePost',
+                            name: true
+                        }]
+                }
+            }
+        };
+        expect(jsonToGraphQLQuery(query)).to.equal(
+            'query { Posts { ... on ConfigurablePost { id } ... on UnconfigurablePost { name } } }'
+        );
+    });
+
     it('we can ignore apollo __typename keys', () => {
         const query = {
             query: {
diff --git a/src/jsonToGraphQLQuery.ts b/src/jsonToGraphQLQuery.ts
@@ -1,7 +1,9 @@
 import { EnumType } from './types/EnumType';
 import { VariableType } from './types/VariableType';
 
-export const configFields = ['__args', '__alias', '__aliasFor', '__variables', '__directives'];
+export const configFields = [
+    '__args', '__alias', '__aliasFor', '__variables', '__directives', '__on', '__fragmentName'
+];
 
 function stringify(obj_from_json: any): string {
     if (obj_from_json instanceof EnumType) {
@@ -61,7 +63,7 @@ function buildDirectives(dirsObj: any): string {
     }
     else {
         throw new Error(`Unsupported type for directive: ${typeof directiveValue}. Types allowed: object, boolean.\n` +
-        `Offending object: ${JSON.stringify(dirsObj)}`);
+            `Offending object: ${JSON.stringify(dirsObj)}`);
     }
 }
 
@@ -74,7 +76,7 @@ function filterNonConfigFields(fieldName: string, ignoreFields: string[]) {
     return configFields.indexOf(fieldName) == -1 && ignoreFields.indexOf(fieldName) == -1;
 }
 
-function convertQuery(node: any, level: number, output: Array<[ string, number ]>, options: IJsonToGraphQLOptions) {
+function convertQuery(node: any, level: number, output: Array<[string, number]>, options: IJsonToGraphQLOptions) {
     Object.keys(node)
         .filter((key) => filterNonConfigFields(key, options.ignoreFields))
         .forEach((key) => {
@@ -86,6 +88,7 @@ function convertQuery(node: any, level: number, output: Array<[ string, number ]
                 const subFields = fieldCount > 0;
                 const argsExist = typeof node[key].__args === 'object';
                 const directivesExist = typeof node[key].__directives === 'object';
+                const inlineFragmentsExist = typeof node[key].__on === 'object';
 
                 let token = `${key}`;
 
@@ -104,8 +107,8 @@ function convertQuery(node: any, level: number, output: Array<[ string, number ]
                         const numDirectives = Object.keys(node[key].__directives).length;
                         if (numDirectives > 1) {
                             throw new Error(`Too many directives. The object/key ` +
-                            `'${Object.keys(node[key])[0]}' had ${numDirectives} directives, ` +
-                            `but only 1 directive per object/key is supported at this time.`);
+                                `'${Object.keys(node[key])[0]}' had ${numDirectives} directives, ` +
+                                `but only 1 directive per object/key is supported at this time.`);
                         }
                         dirsStr = `@${buildDirectives(node[key].__directives)}`;
                     }
@@ -121,17 +124,28 @@ function convertQuery(node: any, level: number, output: Array<[ string, number ]
                     token = `${node[key].__alias}: ${token}`;
                 }
 
-                output.push([ token + (fieldCount > 0 ? ' {' : ''), level ]);
+                output.push([token + (subFields || inlineFragmentsExist ? ' {' : ''), level]);
                 convertQuery(node[key], level + 1, output, options);
 
-                if (subFields) {
-                    output.push([ '}', level ]);
+                if (inlineFragmentsExist) {
+                    const inlineFragments: Array<{ __fragmentName: string }>
+                        = node[key].__on instanceof Array ? node[key].__on : [node[key].__on];
+                    inlineFragments.forEach((inlineFragment) => {
+                        const name = inlineFragment.__fragmentName;
+                        output.push([`... on ${name} {`, level + 1]);
+                        convertQuery(inlineFragment, level + 2, output, options);
+                        output.push(['}', level + 1]);
+                    });
+                }
+
+                if (subFields || inlineFragmentsExist) {
+                    output.push(['}', level]);
                 }
 
             } else if (node[key]) {
-                output.push([ `${key}`, level ]);
+                output.push([`${key}`, level]);
             }
-    });
+        });
 }
 
 export interface IJsonToGraphQLOptions {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "json-to-graphql-query",`
`3`		`- "version": "1.7.0",`
	`3`	`+ "version": "1.8.0",`
`4`	`4`	`"main": "lib/index.js",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"scripts": {`