[7.x] [RAC] [RBAC] working find route for alerts as data client (#107982)

x-pack/plugins/rule_registry/common/types.ts

@@ -7,6 +7,270 @@
 
 import { estypes } from '@elastic/elasticsearch';
 
+import * as t from 'io-ts';
+
+// note: these schemas are not exhaustive. See the `Sort` type of `@elastic/elasticsearch` if you need to enhance it.
+const fieldSchema = t.string;
+export const sortOrderSchema = t.union([t.literal('asc'), t.literal('desc'), t.literal('_doc')]);
+type SortOrderSchema = 'asc' | 'desc' | '_doc';
+const sortModeSchema = t.union([
+  t.literal('min'),
+  t.literal('max'),
+  t.literal('sum'),
+  t.literal('avg'),
+  t.literal('median'),
+]);
+const fieldSortSchema = t.exact(
+  t.partial({
+    missing: t.union([t.string, t.number, t.boolean]),
+    mode: sortModeSchema,
+    order: sortOrderSchema,
+    // nested and unmapped_type not implemented yet
+  })
+);
+const sortContainerSchema = t.record(t.string, t.union([sortOrderSchema, fieldSortSchema]));
+const sortCombinationsSchema = t.union([fieldSchema, sortContainerSchema]);
+export const sortSchema = t.union([sortCombinationsSchema, t.array(sortCombinationsSchema)]);
+
+export const minDocCount = t.number;
+
+interface BucketAggsSchemas {
+  filter?: {
+    term?: { [x: string]: string | boolean | number };
+  };
+  histogram?: {
+    field?: string;
+    interval?: number;
+    min_doc_count?: number;
+    extended_bounds?: {
+      min: number;
+      max: number;
+    };
+    hard_bounds?: {
+      min: number;
+      max: number;
+    };
+    missing?: number;
+    keyed?: boolean;
+    order?: {
+      _count: string;
+      _key: string;
+    };
+  };
+  nested?: {
+    path: string;
+  };
+  terms?: {
+    field?: string;
+    collect_mode?: string;
+    exclude?: string | string[];
+    include?: string | string[];
+    execution_hint?: string;
+    missing?: number | string;
+    min_doc_count?: number;
+    size?: number;
+    show_term_doc_count_error?: boolean;
+    order?:
+      | SortOrderSchema
+      | { [x: string]: SortOrderSchema }
+      | Array<{ [x: string]: SortOrderSchema }>;
+  };
+  aggs?: {
+    [x: string]: BucketAggsSchemas;
+  };
+}
+
+/**
+ * Schemas for the Bucket aggregations.
+ *
+ * Currently supported:
+ * - filter
+ * - histogram
+ * - nested
+ * - terms
+ *
+ * Not implemented:
+ * - adjacency_matrix
+ * - auto_date_histogram
+ * - children
+ * - composite
+ * - date_histogram
+ * - date_range
+ * - diversified_sampler
+ * - filters
+ * - geo_distance
+ * - geohash_grid
+ * - geotile_grid
+ * - global
+ * - ip_range
+ * - missing
+ * - multi_terms
+ * - parent
+ * - range
+ * - rare_terms
+ * - reverse_nested
+ * - sampler
+ * - significant_terms
+ * - significant_text
+ * - variable_width_histogram
+ */
+export const BucketAggsSchemas: t.Type<BucketAggsSchemas> = t.recursion('BucketAggsSchemas', () =>
+  t.exact(
+    t.partial({
+      filter: t.exact(
+        t.partial({
+          term: t.record(t.string, t.union([t.string, t.boolean, t.number])),
+        })
+      ),
+      date_histogram: t.exact(
+        t.partial({
+          field: t.string,
+          fixed_interval: t.string,
+          min_doc_count: t.number,
+          extended_bounds: t.type({
+            min: t.string,
+            max: t.string,
+          }),
+        })
+      ),
+      histogram: t.exact(
+        t.partial({
+          field: t.string,
+          interval: t.number,
+          min_doc_count: t.number,
+          extended_bounds: t.exact(
+            t.type({
+              min: t.number,
+              max: t.number,
+            })
+          ),
+          hard_bounds: t.exact(
+            t.type({
+              min: t.number,
+              max: t.number,
+            })
+          ),
+          missing: t.number,
+          keyed: t.boolean,
+          order: t.exact(
+            t.type({
+              _count: t.string,
+              _key: t.string,
+            })
+          ),
+        })
+      ),
+      nested: t.type({
+        path: t.string,
+      }),
+      terms: t.exact(
+        t.partial({
+          field: t.string,
+          collect_mode: t.string,
+          exclude: t.union([t.string, t.array(t.string)]),
+          include: t.union([t.string, t.array(t.string)]),
+          execution_hint: t.string,
+          missing: t.union([t.number, t.string]),
+          min_doc_count: t.number,
+          size: t.number,
+          show_term_doc_count_error: t.boolean,
+          order: t.union([
+            sortOrderSchema,
+            t.record(t.string, sortOrderSchema),
+            t.array(t.record(t.string, sortOrderSchema)),
+          ]),
+        })
+      ),
+      aggs: t.record(t.string, BucketAggsSchemas),
+    })
+  )
+);
+
+/**
+ * Schemas for the metrics Aggregations
+ *
+ * Currently supported:
+ * - avg
+ * - cardinality
+ * - min
+ * - max
+ * - sum
+ * - top_hits
+ * - weighted_avg
+ *
+ * Not implemented:
+ * - boxplot
+ * - extended_stats
+ * - geo_bounds
+ * - geo_centroid
+ * - geo_line
+ * - matrix_stats
+ * - median_absolute_deviation
+ * - percentile_ranks
+ * - percentiles
+ * - rate
+ * - scripted_metric
+ * - stats
+ * - string_stats
+ * - t_test
+ * - value_count
+ */
+export const metricsAggsSchemas = t.partial({
+  avg: t.partial({
+    field: t.string,
+    missing: t.union([t.string, t.number, t.boolean]),
+  }),
+  cardinality: t.partial({
+    field: t.string,
+    precision_threshold: t.number,
+    rehash: t.boolean,
+    missing: t.union([t.string, t.number, t.boolean]),
+  }),
+  min: t.partial({
+    field: t.string,
+    missing: t.union([t.string, t.number, t.boolean]),
+    format: t.string,
+  }),
+  max: t.partial({
+    field: t.string,
+    missing: t.union([t.string, t.number, t.boolean]),
+    format: t.string,
+  }),
+  sum: t.partial({
+    field: t.string,
+    missing: t.union([t.string, t.number, t.boolean]),
+  }),
+  top_hits: t.partial({
+    explain: t.boolean,
+    docvalue_fields: t.union([t.string, t.array(t.string)]),
+    stored_fields: t.union([t.string, t.array(t.string)]),
+    from: t.number,
+    size: t.number,
+    sort: sortSchema,
+    seq_no_primary_term: t.boolean,
+    version: t.boolean,
+    track_scores: t.boolean,
+    highlight: t.any,
+    _source: t.union([t.boolean, t.string, t.array(t.string)]),
+  }),
+  weighted_avg: t.partial({
+    format: t.string,
+    value_type: t.string,
+    value: t.partial({
+      field: t.string,
+      missing: t.number,
+    }),
+    weight: t.partial({
+      field: t.string,
+      missing: t.number,
+    }),
+  }),
+});
+
+export type PutIndexTemplateRequest = estypes.IndicesPutIndexTemplateRequest & {
+  body?: { composed_of?: string[] };
+};
+
 export interface ClusterPutComponentTemplateBody {
   template: {
     settings: {