wip(Aggs): Described all metrics and started bucket aggregations.

Author: nodkz

package.json

@@ -35,7 +35,7 @@
     "babel-eslint": "^7.1.1",
     "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "babel-plugin-transform-object-rest-spread": "^6.22.0",
-    "babel-preset-env": "^1.2.1",
+    "babel-preset-env": "^1.2.2",
     "cz-conventional-changelog": "^2.0.0",
     "elasticsearch": "^12.1.3",
     "eslint": "^3.17.1",
@@ -48,7 +48,7 @@
     "express-graphql": "^0.6.3",
     "flow-bin": "^0.41.0",
     "graphql": "^0.9.1",
-    "graphql-compose": "^1.17.1",
+    "graphql-compose": "^1.17.2",
     "jest": "^19.0.2",
     "jest-babel": "^1.0.1",
     "npm-run-all": "^4.0.1",

src/ElasticDSL/Aggs/AggRules.js

@@ -7,6 +7,17 @@ import { getAggBlockITC } from './AggBlock';
 import { getAvgITC } from './Metrics/Avg';
 import { getCardinalityITC } from './Metrics/Cardinality';
 import { getExtendedStatsITC } from './Metrics/ExtendedStats';
+import { getGeoBoundsITC } from './Metrics/GeoBounds';
+import { getGeoCentroidITC } from './Metrics/GeoCentroid';
+import { getMaxITC } from './Metrics/Max';
+import { getMinITC } from './Metrics/Min';
+import { getPercentileRanksITC } from './Metrics/PercentileRanks';
+import { getPercentilesITC } from './Metrics/Percentiles';
+import { getScriptedMetricITC } from './Metrics/ScriptedMetric';
+import { getStatsITC } from './Metrics/Stats';
+import { getSumITC } from './Metrics/Sum';
+import { getTopHitsITC } from './Metrics/TopHits';
+import { getValueCountITC } from './Metrics/ValueCount';
 
 export function getAggRulesITC(opts: mixed = {}): InputTypeComposer {
   const name = getTypeName('AggRules', opts);
@@ -28,6 +39,17 @@ export function getAggRulesITC(opts: mixed = {}): InputTypeComposer {
         avg: () => getAvgITC(opts),
         cardinality: () => getCardinalityITC(opts),
         extended_stats: () => getExtendedStatsITC(opts),
+        geo_bounds: () => getGeoBoundsITC(opts),
+        geo_centroid: () => getGeoCentroidITC(opts),
+        max: () => getMaxITC(opts),
+        min: () => getMinITC(opts),
+        percentile_ranks: () => getPercentileRanksITC(opts),
+        percentiles: () => getPercentilesITC(opts),
+        scripted_metric: () => getScriptedMetricITC(opts),
+        stats: () => getStatsITC(opts),
+        sum: () => getSumITC(opts),
+        top_hits: () => getTopHitsITC(opts),
+        value_count: () => getValueCountITC(opts),
 
         aggs: {
           type: () => [getAggBlockITC(opts)],

src/ElasticDSL/Aggs/Bucket/Children.js

@@ -0,0 +1,25 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+
+export function getChildrenITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsChildren', opts);
+  const description = desc(
+    `
+    A special single bucket aggregation that enables aggregating from buckets
+    on parent document types to buckets on child documents.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        type: 'String',
+      },
+    }));
+}

src/ElasticDSL/Aggs/Bucket/DateHistogram.js

@@ -0,0 +1,37 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+import { getCommonsScriptITC } from '../../Commons/Script';
+import {
+  getDateIntervalFC,
+  getDateFormatFC,
+  getDateTimeZoneFC,
+} from '../../Commons/Date';
+
+export function getDateHistogramITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsDateHistogram', opts);
+  const description = desc(
+    `
+    A multi-bucket aggregation similar to the histogram except it can only
+    be applied on date values.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        field: 'String',
+        interval: getDateIntervalFC(opts),
+        time_zone: getDateTimeZoneFC(opts),
+        offset: getDateIntervalFC(opts),
+        format: getDateFormatFC(opts),
+        missing: 'Float',
+        script: () => getCommonsScriptITC(opts),
+      },
+    }));
+}

src/ElasticDSL/Aggs/Bucket/DateRange.js

@@ -0,0 +1,33 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+import { getDateFormatFC, getDateTimeZoneFC } from '../../Commons/Date';
+
+export function getDateRangeITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsDateRange', opts);
+  const description = desc(
+    `
+    A range aggregation that is dedicated for date values. The main difference
+    between this aggregation and the normal range aggregation is that
+    the from and to values can be expressed in Date Math expressions,
+    and it is also possible to specify a date format by which the from
+    and to response fields will be returned. Note that this aggregation
+    includes the from value and excludes the to value for each range.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        field: 'String',
+        format: getDateFormatFC(opts),
+        ranges: () => [getDateRangeITC(opts)],
+        time_zone: getDateTimeZoneFC(opts),
+      },
+    }));
+}

src/ElasticDSL/Aggs/Bucket/DiversifiedSampler.js

@@ -0,0 +1,34 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+import { getCommonsScriptITC } from '../../Commons/Script';
+
+export function getDiversifiedSamplerITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsDiversifiedSampler', opts);
+  const description = desc(
+    `
+    A filtering aggregation used to limit any sub aggregations' processing to
+    a sample of the top-scoring documents. Diversity settings are used to
+    limit the number of matches that share a common value such as an "author".
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-diversified-sampler-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        shard_size: {
+          type: 'String',
+          defaultValue: 100,
+        },
+        field: 'String',
+        max_docs_per_value: 'Int',
+        script: () => getCommonsScriptITC(opts),
+        execution_hint: 'String',
+      },
+    }));
+}

src/ElasticDSL/Aggs/Bucket/Filter.js

@@ -0,0 +1,20 @@
+/* @flow */
+/* eslint-disable no-unused-vars */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+import { getQueryITC } from '../../Query/Query';
+
+export function getFilterITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsFilter', opts);
+  const description = desc(
+    `
+    Defines a single bucket of all the documents in the current document set
+    context that match a specified filter. Often this will be used to narrow
+    down the current aggregation context to a specific set of documents.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filter-aggregation.html)
+  `
+  );
+
+  return getQueryITC(opts);
+}

src/ElasticDSL/Aggs/Bucket/Filters.js

@@ -0,0 +1,28 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+
+export function getFiltersITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsFilters', opts);
+  const description = desc(
+    `
+    Defines a multi bucket aggregation where each bucket is associated
+    with a filter. Each bucket will collect all documents that match
+    its associated filter.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        filters: 'JSON',
+        other_bucket: 'Boolean',
+        other_bucket_key: 'String',
+      },
+    }));
+}

src/ElasticDSL/Aggs/Bucket/GeoDistance.js

@@ -0,0 +1,37 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+import {
+  getGeoPointFC,
+  getDistanceUnitFC,
+  getDistanceCalculationModeFC,
+} from '../../Commons/Geo';
+import { getFloatRangeITC } from '../../Commons/Float';
+
+export function getGeoDistanceITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsGeoDistance', opts);
+  const description = desc(
+    `
+    A multi-bucket aggregation that works on geo_point fields. The user can
+    define a point of origin and a set of distance range buckets.
+    The aggregation evaluate the distance of each document value from the
+    origin point and determines the buckets it belongs to based on the ranges
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-geodistance-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        field: 'String',
+        origin: getGeoPointFC(opts),
+        ranges: [getFloatRangeITC(opts)],
+        unit: getDistanceUnitFC(opts),
+        distance_type: getDistanceCalculationModeFC(opts),
+      },
+    }));
+}

src/ElasticDSL/Aggs/Metrics/Avg.js

@@ -22,7 +22,7 @@ export function getAvgITC(opts: mixed = {}): InputTypeComposer {
       fields: {
         field: 'String',
         missing: 'Float',
-        script: () => getCommonsScriptITC(),
+        script: () => getCommonsScriptITC(opts),
       },
     })
   );

src/ElasticDSL/Aggs/Metrics/Cardinality.js

@@ -33,7 +33,7 @@ export function getCardinalityITC(opts: mixed = {}): InputTypeComposer {
           ),
         },
         missing: 'String',
-        script: () => getCommonsScriptITC(),
+        script: () => getCommonsScriptITC(opts),
       },
     }));
 }

src/ElasticDSL/Aggs/Metrics/ExtendedStats.js

@@ -25,7 +25,7 @@ export function getExtendedStatsITC(opts: mixed = {}): InputTypeComposer {
         field: 'String',
         sigma: 'Float',
         missing: 'Float',
-        script: () => getCommonsScriptITC(),
+        script: () => getCommonsScriptITC(opts),
       },
     }));
 }

src/ElasticDSL/Aggs/Metrics/GeoBounds.js

@@ -0,0 +1,26 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+
+export function getGeoBoundsITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsGeoBounds', opts);
+  const description = desc(
+    `
+    A metric aggregation that computes the bounding box containing
+    all geo_point values for a field.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geobounds-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        field: 'String!',
+        wrap_longitude: 'Boolean',
+      },
+    }));
+}

src/ElasticDSL/Aggs/Metrics/GeoCentroid.js

@@ -0,0 +1,25 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+
+export function getGeoCentroidITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsGeoCentroid', opts);
+  const description = desc(
+    `
+    A metric aggregation that computes the weighted centroid from all coordinate
+    values for a Geo-point datatype field.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-geocentroid-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        field: 'String!',
+      },
+    }));
+}

src/ElasticDSL/Aggs/Metrics/Max.js

@@ -0,0 +1,30 @@
+/* @flow */
+
+import { InputTypeComposer } from 'graphql-compose';
+import { getTypeName, getOrSetType, desc } from '../../../utils';
+import { getCommonsScriptITC } from '../../Commons/Script';
+
+export function getMaxITC(opts: mixed = {}): InputTypeComposer {
+  const name = getTypeName('AggsMax', opts);
+  const description = desc(
+    `
+    A single-value metrics aggregation that keeps track and returns the maximum
+    value among the numeric values extracted from the aggregated documents.
+    These values can be extracted either from specific numeric fields 
+    in the documents, or be generated by a provided script.
+    [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html)
+  `
+  );
+
+  return getOrSetType(name, () =>
+    // $FlowFixMe
+    InputTypeComposer.create({
+      name,
+      description,
+      fields: {
+        field: 'String',
+        missing: 'Float',
+        script: () => getCommonsScriptITC(opts),
+      },
+    }));
+}