TS of esKuery\node_types (#56857)

* TS of node types and collector * Code review
elastic · Feb 7, 2020 · 9a79acf · 9a79acf
1 parent 54add37
commit 9a79acf
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 32 deletions.
diff --git a/...mon/es_query/kuery/node_types/function.js → ...mon/es_query/kuery/node_types/function.ts b/...mon/es_query/kuery/node_types/function.js → ...mon/es_query/kuery/node_types/function.ts
@@ -18,9 +18,13 @@
  */
 
 import _ from 'lodash';
+// @ts-ignore
 import { functions } from '../functions';
+import { IIndexPattern } from '../../..';
+import { FunctionName, FunctionTypeBuildNode } from './types';
+import { JsonValue } from '..';
 
-export function buildNode(functionName, ...functionArgs) {
+export function buildNode(functionName: FunctionName, ...args: any[]) {
   const kueryFunction = functions[functionName];
   if (_.isUndefined(kueryFunction)) {
     throw new Error(`Unknown function "${functionName}"`);
@@ -29,24 +33,32 @@ export function buildNode(functionName, ...functionArgs) {
   return {
     type: 'function',
     function: functionName,
-    ...kueryFunction.buildNodeParams(...functionArgs),
+    ...kueryFunction.buildNodeParams(...args),
   };
 }
 
 // Mainly only useful in the grammar where we'll already have real argument nodes in hand
-export function buildNodeWithArgumentNodes(functionName, argumentNodes) {
+export function buildNodeWithArgumentNodes(
+  functionName: FunctionName,
+  args: any[]
+): FunctionTypeBuildNode {
   if (_.isUndefined(functions[functionName])) {
     throw new Error(`Unknown function "${functionName}"`);
   }
 
   return {
     type: 'function',
     function: functionName,
-    arguments: argumentNodes,
+    arguments: args,
   };
 }
 
-export function toElasticsearchQuery(node, indexPattern, config = {}, context = {}) {
+export function toElasticsearchQuery(
+  node: any,
+  indexPattern?: IIndexPattern,
+  config?: Record<string, any>,
+  context?: Record<string, any>
+): JsonValue {
   const kueryFunction = functions[node.function];
   return kueryFunction.toElasticsearchQuery(node, indexPattern, config, context);
 }
diff --git a/...common/es_query/kuery/node_types/index.js → ...common/es_query/kuery/node_types/index.ts b/...common/es_query/kuery/node_types/index.js → ...common/es_query/kuery/node_types/index.ts
@@ -21,8 +21,11 @@ import * as functionType from './function';
 import * as literal from './literal';
 import * as namedArg from './named_arg';
 import * as wildcard from './wildcard';
+import { NodeTypes } from './types';
 
-export const nodeTypes = {
+export { NodeTypes };
+
+export const nodeTypes: NodeTypes = {
   function: functionType,
   literal,
   namedArg,

diff --git a/...mmon/es_query/kuery/node_types/literal.js → ...mmon/es_query/kuery/node_types/literal.ts b/...mmon/es_query/kuery/node_types/literal.js → ...mmon/es_query/kuery/node_types/literal.ts
@@ -17,13 +17,15 @@
  * under the License.
  */
 
-export function buildNode(value) {
+import { LiteralTypeBuildNode } from './types';
+
+export function buildNode(value: LiteralTypeBuildNode['value']): LiteralTypeBuildNode {
   return {
     type: 'literal',
     value,
   };
 }
 
-export function toElasticsearchQuery(node) {
+export function toElasticsearchQuery(node: LiteralTypeBuildNode): LiteralTypeBuildNode['value'] {
   return node.value;
 }
diff --git a/...on/es_query/kuery/node_types/named_arg.js → ...on/es_query/kuery/node_types/named_arg.ts b/...on/es_query/kuery/node_types/named_arg.js → ...on/es_query/kuery/node_types/named_arg.ts
@@ -20,8 +20,10 @@
 import _ from 'lodash';
 import * as ast from '../ast';
 import { nodeTypes } from '../node_types';
+import { NamedArgTypeBuildNode } from './types';
+import { JsonObject } from '../types';
 
-export function buildNode(name, value) {
+export function buildNode(name: string, value: any): NamedArgTypeBuildNode {
   const argumentNode =
     _.get(value, 'type') === 'literal' ? value : nodeTypes.literal.buildNode(value);
   return {
@@ -31,6 +33,6 @@ export function buildNode(name, value) {
   };
 }
 
-export function toElasticsearchQuery(node) {
+export function toElasticsearchQuery(node: any): JsonObject {
   return ast.toElasticsearchQuery(node.value);
 }
diff --git a/...mmon/es_query/kuery/node_types/index.d.ts → ...common/es_query/kuery/node_types/types.ts b/...mmon/es_query/kuery/node_types/index.d.ts → ...common/es_query/kuery/node_types/types.ts
@@ -22,9 +22,9 @@
  */
 
 import { IIndexPattern } from '../../../index_patterns';
-import { KueryNode, JsonValue } from '..';
+import { JsonValue, KueryNode } from '..';
 
-type FunctionName =
+export type FunctionName =
   | 'is'
   | 'and'
   | 'or'
@@ -37,7 +37,7 @@ type FunctionName =
 
 interface FunctionType {
   buildNode: (functionName: FunctionName, ...args: any[]) => FunctionTypeBuildNode;
-  buildNodeWithArgumentNodes: (functionName: FunctionName, ...args: any[]) => FunctionTypeBuildNode;
+  buildNodeWithArgumentNodes: (functionName: FunctionName, args: any[]) => FunctionTypeBuildNode;
   toElasticsearchQuery: (
     node: any,
     indexPattern?: IIndexPattern,
@@ -46,7 +46,7 @@ interface FunctionType {
   ) => JsonValue;
 }
 
-interface FunctionTypeBuildNode {
+export interface FunctionTypeBuildNode {
   type: 'function';
   function: FunctionName;
   // TODO -> Need to define a better type for DSL query
@@ -58,40 +58,38 @@ interface LiteralType {
   toElasticsearchQuery: (node: any) => null | boolean | number | string;
 }
 
-interface LiteralTypeBuildNode {
+export interface LiteralTypeBuildNode {
   type: 'literal';
   value: null | boolean | number | string;
 }
 
 interface NamedArgType {
   buildNode: (name: string, value: any) => NamedArgTypeBuildNode;
-  toElasticsearchQuery: (node: any) => string;
+  toElasticsearchQuery: (node: any) => JsonValue;
 }
 
-interface NamedArgTypeBuildNode {
+export interface NamedArgTypeBuildNode {
   type: 'namedArg';
   name: string;
   value: any;
 }
 
 interface WildcardType {
-  buildNode: (value: string) => WildcardTypeBuildNode;
+  buildNode: (value: string) => WildcardTypeBuildNode | KueryNode;
   test: (node: any, string: string) => boolean;
   toElasticsearchQuery: (node: any) => string;
   toQueryStringQuery: (node: any) => string;
   hasLeadingWildcard: (node: any) => boolean;
 }
 
-interface WildcardTypeBuildNode {
+export interface WildcardTypeBuildNode {
   type: 'wildcard';
   value: string;
 }
 
-interface NodeTypes {
+export interface NodeTypes {
   function: FunctionType;
   literal: LiteralType;
   namedArg: NamedArgType;
   wildcard: WildcardType;
 }
-
-export const nodeTypes: NodeTypes;
diff --git a/...mon/es_query/kuery/node_types/wildcard.js → ...mon/es_query/kuery/node_types/wildcard.ts b/...mon/es_query/kuery/node_types/wildcard.js → ...mon/es_query/kuery/node_types/wildcard.ts
@@ -18,20 +18,22 @@
  */
 
 import { fromLiteralExpression } from '../ast/ast';
+import { WildcardTypeBuildNode } from './types';
+import { KueryNode } from '..';
 
 export const wildcardSymbol = '@kuery-wildcard@';
 
 // Copied from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
-function escapeRegExp(string) {
-  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+function escapeRegExp(str: string) {
+  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 }
 
 // See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#_reserved_characters
-function escapeQueryString(string) {
-  return string.replace(/[+-=&|><!(){}[\]^"~*?:\\/]/g, '\\$&'); // $& means the whole matched string
+function escapeQueryString(str: string) {
+  return str.replace(/[+-=&|><!(){}[\]^"~*?:\\/]/g, '\\$&'); // $& means the whole matched string
 }
 
-export function buildNode(value) {
+export function buildNode(value: string): WildcardTypeBuildNode | KueryNode {
   if (!value.includes(wildcardSymbol)) {
     return fromLiteralExpression(value);
   }
@@ -42,30 +44,30 @@ export function buildNode(value) {
   };
 }
 
-export function test(node, string) {
+export function test(node: any, str: string): boolean {
   const { value } = node;
   const regex = value
     .split(wildcardSymbol)
     .map(escapeRegExp)
     .join('[\\s\\S]*');
   const regexp = new RegExp(`^${regex}$`);
-  return regexp.test(string);
+  return regexp.test(str);
 }
 
-export function toElasticsearchQuery(node) {
+export function toElasticsearchQuery(node: any): string {
   const { value } = node;
   return value.split(wildcardSymbol).join('*');
 }
 
-export function toQueryStringQuery(node) {
+export function toQueryStringQuery(node: any): string {
   const { value } = node;
   return value
     .split(wildcardSymbol)
     .map(escapeQueryString)
     .join('*');
 }
 
-export function hasLeadingWildcard(node) {
+export function hasLeadingWildcard(node: any): boolean {
   const { value } = node;
   // A lone wildcard turns into an `exists` query, so we're only concerned with
   // leading wildcards followed by additional characters.