feat(Search): Add field searchTyped with described inputs, search now has untyped body

Author: nodkz

.eslintrc

@@ -21,6 +21,11 @@
     "no-plusplus": 0,
     "import/no-extraneous-dependencies": 0,
     "import/prefer-default-export": 0,
+    "prettier/prettier": ["error", {
+      "printWidth": 80,
+      "singleQuote": true,
+      "trailingComma": "es5",
+    }]
   },
   "env": {
     "jasmine": true,

README.md

@@ -1,7 +1,7 @@
 graphql-compose-elasticsearch
 ======================
 [![](https://img.shields.io/npm/v/graphql-compose-elasticsearch.svg)](https://www.npmjs.com/package/graphql-compose-elasticsearch)
-[![npm](https://img.shields.io/npm/dt/graphql-compose-elasticsearch.svg)](https://www.npmjs.com/package/graphql-compose-elasticsearch)
+[![npm](https://img.shields.io/npm/dt/graphql-compose-elasticsearch.svg)](http://www.npmtrends.com/graphql-compose-elasticsearch)
 [![Travis](https://img.shields.io/travis/nodkz/graphql-compose-elasticsearch.svg?maxAge=2592000)](https://travis-ci.org/nodkz/graphql-compose-elasticsearch)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

src/ElasticApiParser.js

@@ -13,7 +13,7 @@ import {
   GraphQLNonNull,
 } from 'graphql';
 import { GraphQLJSON, upperFirst, TypeComposer } from 'graphql-compose';
-import { getSearchBodyITC } from './ElasticDSL/SearchBody';
+import { getSearchBodyITC, prepareSearchArgs } from './ElasticDSL/SearchBody';
 
 import type {
   GraphQLArgumentConfig,
@@ -24,7 +24,7 @@ import type {
 
 export type ElasticApiParserOptsT = {
   version?:
-    '5_0'
+    | '5_0'
     | '5_x'
     | '2_4'
     | '2_3'
@@ -81,15 +81,40 @@ export default class ElasticApiParser {
     // from ../../node_modules/elasticsearch/src/lib/apis/VERSION.js
     this.version = opts.version || '5_0';
     this.prefix = opts.prefix || 'Elastic';
-    this.elasticApiFilesPath = opts.elasticApiFilesPath || './node_modules/elasticsearch/src/lib/apis/';
+    this.elasticApiFilesPath = opts.elasticApiFilesPath ||
+      './node_modules/elasticsearch/src/lib/apis/';
     this.cachedEnums = {};
   }
 
-  run() {
+  run(): GraphQLFieldMap<*, *> {
     this.cachedEnums = {};
-    const apiFilePath = path.resolve(this.elasticApiFilesPath, `${this.version}.js`);
+    const apiFilePath = path.resolve(
+      this.elasticApiFilesPath,
+      `${this.version}.js`
+    );
     const source = this.loadApiFile(apiFilePath);
-    return this.parseSource(source);
+    return this.addTypedSearch(this.parseSource(source));
+  }
+
+  addTypedSearch(fields: GraphQLFieldMap<*, *>): GraphQLFieldMap<*, *> {
+    if (fields.search) {
+      const { type, description, args, resolve } = fields.search;
+      const searchTyped = {
+        type,
+        description,
+        resolve: prepareSearchArgs(resolve),
+        // $FlowFixMe
+        args: Object.assign({}, args, {
+          body: {
+            type: getSearchBodyITC({
+              prefix: this.prefix,
+            }).getType(),
+          },
+        }),
+      };
+      return { searchTyped, ...fields };
+    }
+    return fields;
   }
 
   parseSource(source: string): GraphQLFieldMap<*, *> {
@@ -126,12 +151,6 @@ export default class ElasticApiParser {
 
       const elasticMethod = this.getMethodName(item.ctx.string);
 
-      if (elasticMethod === 'search') {
-        argMap.body.type = getSearchBodyITC({
-          prefix: this.prefix,
-        }).getType();
-      }
-
       result[item.ctx.string] = {
         type: GraphQLJSON,
         description,
@@ -232,7 +251,7 @@ export default class ElasticApiParser {
     };
     if (paramCfg.default) {
       result.defaultValue = paramCfg.default;
-    } else if(fieldName === 'format') {
+    } else if (fieldName === 'format') {
       result.defaultValue = 'json';
     }
 
@@ -265,7 +284,9 @@ export default class ElasticApiParser {
         // eg '@param {anything} params.operationThreading - ?'
         return GraphQLJSON;
       default:
-        console.log(`New type '${paramCfg.type}' in elastic params setting for field ${fieldName}.`); // eslint-disable-line
+        console.log(
+          `New type '${paramCfg.type}' in elastic params setting for field ${fieldName}.`
+        ); // eslint-disable-line
         return GraphQLJSON;
     }
   }
@@ -369,7 +390,9 @@ export default class ElasticApiParser {
               // $FlowFixMe
               fields: () => {},
             }),
-            resolve: () => { return {}; },
+            resolve: () => {
+              return {};
+            },
           };
         }
         TypeComposer.create(result[name[0]].type).setField(name[1], fields[k]);

src/ElasticDSL/Commons/Script.js

@@ -0,0 +1,25 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from "../../utils";
+
+export function getCommonsScriptITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('CommonsScript', opts);
+  const description = desc(`
+    The scripting module enables you to use scripts to evaluate custom expressions.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html)
+  `);
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        lang: 'String!',
+        inline: 'String!',
+        params: 'JSON',
+      },
+    })
+  );
+}

src/ElasticDSL/Query/Specialized/Script.js

@@ -2,6 +2,7 @@
 
 import { InputTypeComposer } from 'graphql-compose';
 import { getTypeName, getOrSetType, desc } from "../../../utils";
+import { getCommonsScriptITC } from '../../Commons/Script';
 
 export function getScriptITC(opts: mixed = {}): InputTypeComposer {
   const name = getTypeName('QueryScript', opts);
@@ -16,11 +17,7 @@ export function getScriptITC(opts: mixed = {}): InputTypeComposer {
       name,
       description,
       fields: {
-        script: `input ${getTypeName('QueryScriptScript', opts)} {
-          inline: String!
-          lang: String!
-          params: JSON
-        }`,
+        script: () => getCommonsScriptITC(),
       },
     })
   );

src/ElasticDSL/Query/Query.test.js renamed to src/ElasticDSL/__tests__/SearchDSL-test.js

@@ -1,9 +1,9 @@
 /* @flow */
 import { printSchema, GraphQLSchema, GraphQLObjectType, GraphQLInt } from 'graphql';
-import { getQueryITC } from './Query';
+import { getQueryITC } from '../Query/Query';
 
-describe('Elastic DSL Query', () => {
-  it('should match', () => {
+describe('Elastic Search DSL', () => {
+  it('Query DSL', () => {
     const schema = new GraphQLSchema({
       query: new GraphQLObjectType({
         name: 'RootQuery',

src/ElasticDSL/Query/__snapshots__/Query.test.js.snap renamed to src/ElasticDSL/__tests__/__snapshots__/SearchDSL-test.js.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Elastic DSL Query should match 1`] = `
+exports[`Elastic Search DSL Query DSL 1`] = `
 "schema {
   query: RootQuery
 }
@@ -302,13 +302,7 @@ enum Elastic_QueryQueryStringOperatorEnum_50 {
 # A query allowing to define scripts as queries. They are typically used in a
 # filter context. [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-script-query.html) 
 input Elastic_QueryScript_50 {
-  script: Elastic_QueryScriptScript_50
-}
-
-input Elastic_QueryScriptScript_50 {
-  inline: String!
-  lang: String!
-  params: JSON
+  script: ElasticCommonsScript
 }
 
 # A query that uses the SimpleQueryParser to parse its context. Unlike the regular
@@ -336,6 +330,13 @@ enum Elastic_QuerySimpleQueryStringOperatorEnum_50 {
   or
 }
 
+# The scripting module enables you to use scripts to evaluate custom expressions. [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html) 
+input ElasticCommonsScript {
+  lang: String!
+  inline: String!
+  params: JSON
+}
+
 # The \`JSON\` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
 scalar JSON
 

src/__tests__/__snapshots__/ElasticApiParser-test.js.snap

@@ -33,7 +33,7 @@ Object {
         "type": "String",
       },
       "body": Object {
-        "type": "ElasticSearchBody",
+        "type": "JSON",
       },
       "defaultOperator": Object {
         "defaultValue": "OR",