Move Expression typings from Canvas to OSS Interpreter

src/legacy/core_plugins/interpreter/common/types/index.js → src/legacy/core_plugins/interpreter/common/types/index.ts

@@ -17,17 +17,29 @@
  * under the License.
  */
 
+// @ts-ignore
 import { boolean } from './boolean';
+// @ts-ignore
 import { datatable } from './datatable';
+// @ts-ignore
 import { error } from './error';
+// @ts-ignore
 import { filter } from './filter';
+// @ts-ignore
 import { image } from './image';
+// @ts-ignore
 import { nullType } from './null';
+// @ts-ignore
 import { number } from './number';
+// @ts-ignore
 import { pointseries } from './pointseries';
+// @ts-ignore
 import { render } from './render';
+// @ts-ignore
 import { shape } from './shape';
+// @ts-ignore
 import { string } from './string';
+// @ts-ignore
 import { style } from './style';
 import { kibanaContext } from './kibana_context';
 import { kibanaDatatable } from './kibana_datatable';
@@ -48,3 +60,6 @@ export const typeSpecs = [
   kibanaContext,
   kibanaDatatable,
 ];
+
+export { KibanaContext } from './kibana_context';
+export { KibanaDatatable } from './kibana_datatable';

src/legacy/core_plugins/interpreter/common/types/kibana_context.js → src/legacy/core_plugins/interpreter/common/types/kibana_context.ts

@@ -17,12 +17,23 @@
  * under the License.
  */
 
+import { Filters, Query, TimeRange } from 'ui/visualize';
+
+const name = 'kibana_context';
+
+export interface KibanaContext {
+  type: typeof name;
+  query?: Query;
+  filters?: Filters;
+  timeRange?: TimeRange;
+}
+
 export const kibanaContext = () => ({
-  name: 'kibana_context',
+  name,
   from: {
     null: () => {
       return {
-        type: 'kibana_context',
+        type: name,
       };
     },
   },
@@ -32,5 +43,5 @@ export const kibanaContext = () => ({
         type: 'null',
       };
     },
-  }
+  },
 });

src/legacy/core_plugins/interpreter/common/types/kibana_datatable.js → src/legacy/core_plugins/interpreter/common/types/kibana_datatable.ts

@@ -19,30 +19,49 @@
 
 import { map } from 'lodash';
 
+const name = 'kibana_datatable';
+
+interface Column {
+  id: string;
+  name: string;
+}
+
+interface Row {
+  [key: string]: unknown;
+}
+
+export interface KibanaDatatable {
+  type: typeof name;
+  columns: Column[];
+  rows: Row[];
+}
+
 export const kibanaDatatable = () => ({
-  name: 'kibana_datatable',
+  name,
   from: {
-    datatable: context => {
+    // TODO: import datatable types here instead of using any
+    datatable: (context: any) => {
       return {
-        type: 'kibana_datatable',
+        type: name,
         rows: context.rows,
-        columns: context.columns.map(column => {
+        columns: context.columns.map((column: any) => {
           return {
             id: column.name,
             name: column.name,
           };
         }),
       };
     },
-    pointseries: context => {
-      const columns = map(context.columns, (column, name) => {
-        return { id: name, name, ...column };
+    // TODO: import pointseries types here instead of using any
+    pointseries: (context: any) => {
+      const columns = map(context.columns, (column, n) => {
+        return { id: n, name: n, ...column };
       });
       return {
-        type: 'kibana_datatable',
+        type: name,
         rows: context.rows,
-        columns: columns,
+        columns,
       };
-    }
+    },
   },
 });

src/legacy/core_plugins/interpreter/public/functions/esaggs.js → src/legacy/core_plugins/interpreter/public/functions/esaggs.ts

@@ -19,11 +19,15 @@
 
 import { get } from 'lodash';
 import { i18n } from '@kbn/i18n';
+// @ts-ignore
 import { CourierRequestHandlerProvider } from 'ui/vis/request_handlers/courier';
-import { AggConfigs } from 'ui/vis/agg_configs';
+// @ts-ignore
+import { AggConfigs } from 'ui/vis/agg_configs.js';
 
 // need to get rid of angular from these
+// @ts-ignore
 import { IndexPatternsProvider } from 'ui/index_patterns';
+// @ts-ignore
 import { SearchSourceProvider } from 'ui/courier/search_source';
 import { FilterBarQueryFilterProvider } from 'ui/filter_bar/query_filter';
 
@@ -32,37 +36,56 @@ import chrome from 'ui/chrome';
 const courierRequestHandlerProvider = CourierRequestHandlerProvider;
 const courierRequestHandler = courierRequestHandlerProvider().handler;
 
-export const esaggs = () => ({
-  name: 'esaggs',
+import { ExpressionFunction } from '../types';
+import { KibanaContext, KibanaDatatable } from '../../common/types';
+
+const name = 'esaggs';
+
+type Context = KibanaContext | null;
+
+interface Arguments {
+  index: string | null;
+  metricsAtAllLevels: boolean;
+  partialRows: boolean;
+  aggConfigs: string;
+}
+
+type Return = Promise<KibanaDatatable>;
+
+export const esaggs = (): ExpressionFunction<typeof name, Context, Arguments, Return> => ({
+  name,
   type: 'kibana_datatable',
   context: {
-    types: [
-      'kibana_context',
-      'null',
-    ],
+    types: ['kibana_context', 'null'],
   },
-  help: i18n.translate('interpreter.functions.esaggs.help', { defaultMessage: 'Run AggConfig aggregation' }),
+  help: i18n.translate('interpreter.functions.esaggs.help', {
+    defaultMessage: 'Run AggConfig aggregation',
+  }),
   args: {
     index: {
       types: ['string', 'null'],
       default: null,
+      help: '',
     },
     metricsAtAllLevels: {
       types: ['boolean'],
       default: false,
+      help: '',
     },
     partialRows: {
       types: ['boolean'],
       default: false,
+      help: '',
     },
     aggConfigs: {
       types: ['string'],
       default: '""',
+      help: '',
     },
   },
   async fn(context, args, handlers) {
     const $injector = await chrome.dangerouslyGetActiveInjector();
-    const Private = $injector.get('Private');
+    const Private: Function = $injector.get('Private');
     const indexPatterns = Private(IndexPatternsProvider);
     const SearchSource = Private(SearchSourceProvider);
     const queryFilter = Private(FilterBarQueryFilterProvider);
@@ -76,9 +99,9 @@ export const esaggs = () => ({
     searchSource.setField('index', indexPattern);
     searchSource.setField('size', 0);
 
-    const response = await courierRequestHandler({
-      searchSource: searchSource,
-      aggs: aggs,
+    const response: Pick<KibanaDatatable, 'columns' | 'rows'> = await courierRequestHandler({
+      searchSource,
+      aggs,
       timeRange: get(context, 'timeRange', null),
       query: get(context, 'query', null),
       filters: get(context, 'filters', null),

src/legacy/core_plugins/interpreter/public/types.ts

@@ -0,0 +1,20 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export * from '../types';