[Maps] Convert AbstractSource and AbstractLayer to TS (#63533) (#64182)

elastic · Apr 22, 2020 · 23bc168 · 23bc168
1 parent ac06ad8
commit 23bc168
Show file tree

Hide file tree

Showing 30 changed files with 861 additions and 723 deletions.
diff --git a/x-pack/plugins/maps/common/constants.ts b/x-pack/plugins/maps/common/constants.ts
@@ -166,6 +166,7 @@ export enum STYLE_TYPE {
 export enum LAYER_STYLE_TYPE {
   VECTOR = 'VECTOR',
   HEATMAP = 'HEATMAP',
+  TILE = 'TILE',
 }
 
 export const COLOR_MAP_TYPE = {

diff --git a/x-pack/plugins/maps/common/descriptor_types/descriptor_types.d.ts b/x-pack/plugins/maps/common/descriptor_types/descriptor_types.d.ts
@@ -5,8 +5,9 @@
  */
 /* eslint-disable @typescript-eslint/consistent-type-definitions */
 
+import { Query } from 'src/plugins/data/public';
 import { AGG_TYPE, GRID_RESOLUTION, RENDER_AS, SORT_ORDER, SCALING_TYPES } from '../constants';
-import { VectorStyleDescriptor } from './style_property_descriptor_types';
+import { StyleDescriptor, VectorStyleDescriptor } from './style_property_descriptor_types';
 import { DataRequestDescriptor } from './data_request_descriptor_types';
 
 export type AttributionDescriptor = {
@@ -17,6 +18,7 @@ export type AttributionDescriptor = {
 export type AbstractSourceDescriptor = {
   id?: string;
   type: string;
+  applyGlobalQuery?: boolean;
 };
 
 export type EMSTMSSourceDescriptor = AbstractSourceDescriptor & {
@@ -71,17 +73,15 @@ export type ESTermSourceDescriptor = AbstractESAggSourceDescriptor & {
   term: string; // term field name
 };
 
-export type KibanaRegionmapSourceDescriptor = {
-  type: string;
+export type KibanaRegionmapSourceDescriptor = AbstractSourceDescriptor & {
   name: string;
 };
 
-export type KibanaTilemapSourceDescriptor = {
-  type: string;
-};
+// This is for symmetry with other sources only.
+// It takes no additional configuration since  all params are in the .yml.
+export type KibanaTilemapSourceDescriptor = AbstractSourceDescriptor;
 
-export type WMSSourceDescriptor = {
-  type: string;
+export type WMSSourceDescriptor = AbstractSourceDescriptor & {
   serviceUrl: string;
   layers: string;
   styles: string;
@@ -111,6 +111,8 @@ export type JoinDescriptor = {
   right: ESTermSourceDescriptor;
 };
 
+// todo : this union type is incompatible with dynamic extensibility of sources.
+// Reconsider using SourceDescriptor in type signatures for top-level classes
 export type SourceDescriptor =
   | XYZTMSSourceDescriptor
   | WMSSourceDescriptor
@@ -121,20 +123,24 @@ export type SourceDescriptor =
   | ESGeoGridSourceDescriptor
   | EMSFileSourceDescriptor
   | ESPewPewSourceDescriptor
-  | TiledSingleLayerVectorSourceDescriptor;
+  | TiledSingleLayerVectorSourceDescriptor
+  | EMSTMSSourceDescriptor
+  | EMSFileSourceDescriptor;
 
 export type LayerDescriptor = {
   __dataRequests?: DataRequestDescriptor[];
   __isInErrorState?: boolean;
   __errorMessage?: string;
   alpha?: number;
   id: string;
-  label?: string;
+  label?: string | null;
   minZoom?: number;
   maxZoom?: number;
-  sourceDescriptor: SourceDescriptor;
+  sourceDescriptor: SourceDescriptor | null;
   type?: string;
   visible?: boolean;
+  style?: StyleDescriptor | null;
+  query?: Query;
 };
 
 export type VectorLayerDescriptor = LayerDescriptor & {

diff --git a/x-pack/plugins/maps/common/descriptor_types/style_property_descriptor_types.d.ts b/x-pack/plugins/maps/common/descriptor_types/style_property_descriptor_types.d.ts
@@ -182,7 +182,11 @@ export type VectorStylePropertiesDescriptor = {
   [VECTOR_STYLES.LABEL_BORDER_SIZE]?: LabelBorderSizeStylePropertyDescriptor;
 };
 
-export type VectorStyleDescriptor = {
+export type StyleDescriptor = {
+  type: string;
+};
+
+export type VectorStyleDescriptor = StyleDescriptor & {
   type: LAYER_STYLE_TYPE.VECTOR;
   properties: VectorStylePropertiesDescriptor;
 };

diff --git a/x-pack/plugins/maps/public/angular/get_initial_layers.test.js b/x-pack/plugins/maps/public/angular/get_initial_layers.test.js
@@ -52,7 +52,7 @@ describe('kibana.yml configured with map.tilemap.url', () => {
         sourceDescriptor: {
           type: 'KIBANA_TILEMAP',
         },
-        style: {},
+        style: { type: 'TILE' },
         type: 'TILE',
         visible: true,
       },
@@ -96,7 +96,7 @@ describe('EMS is enabled', () => {
           isAutoSelect: true,
           type: 'EMS_TMS',
         },
-        style: {},
+        style: { type: 'TILE' },
         type: 'VECTOR_TILE',
         visible: true,
       },

diff --git a/x-pack/plugins/maps/public/layers/blended_vector_layer.ts b/x-pack/plugins/maps/public/layers/blended_vector_layer.ts
@@ -24,7 +24,7 @@ import {
 } from '../../common/constants';
 import { ESGeoGridSource } from './sources/es_geo_grid_source/es_geo_grid_source';
 import { canSkipSourceUpdate } from './util/can_skip_fetch';
-import { IVectorLayer, VectorLayerArguments } from './vector_layer';
+import { IVectorLayer } from './vector_layer';
 import { IESSource } from './sources/es_source';
 import { IESAggSource } from './sources/es_agg_source';
 import { ISource } from './sources/source';
@@ -36,6 +36,8 @@ import {
   DynamicStylePropertyOptions,
   VectorLayerDescriptor,
 } from '../../common/descriptor_types';
+import { IStyle } from './styles/style';
+import { IVectorSource } from './sources/vector_source';
 
 const ACTIVE_COUNT_DATA_ID = 'ACTIVE_COUNT_DATA_ID';
 
@@ -145,6 +147,11 @@ function getClusterStyleDescriptor(
   return clusterStyleDescriptor;
 }
 
+export interface BlendedVectorLayerArguments {
+  source: IVectorSource;
+  layerDescriptor: VectorLayerDescriptor;
+}
+
 export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
   static type = LAYER_TYPE.BLENDED_VECTOR;
 
@@ -163,11 +170,14 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
   private readonly _documentSource: IESSource;
   private readonly _documentStyle: IVectorStyle;
 
-  constructor(options: VectorLayerArguments) {
-    super(options);
+  constructor(options: BlendedVectorLayerArguments) {
+    super({
+      ...options,
+      joins: [],
+    });
 
     this._documentSource = this._source as IESSource; // VectorLayer constructor sets _source as document source
-    this._documentStyle = this._style; // VectorLayer constructor sets _style as document source
+    this._documentStyle = this._style as IVectorStyle; // VectorLayer constructor sets _style as document source
 
     this._clusterSource = getClusterSource(this._documentSource, this._documentStyle);
     const clusterStyleDescriptor = getClusterStyleDescriptor(
@@ -229,11 +239,11 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
     return this._documentSource;
   }
 
-  getCurrentStyle() {
+  getCurrentStyle(): IStyle {
     return this._isClustered ? this._clusterStyle : this._documentStyle;
   }
 
-  getStyleForEditing() {
+  getStyleForEditing(): IStyle {
     return this._documentStyle;
   }
 
@@ -242,8 +252,8 @@ export class BlendedVectorLayer extends VectorLayer implements IVectorLayer {
     const requestToken = Symbol(`layer-active-count:${this.getId()}`);
     const searchFilters = this._getSearchFilters(
       syncContext.dataFilters,
-      this.getSource(),
-      this.getCurrentStyle()
+      this.getSource() as IVectorSource,
+      this.getCurrentStyle() as IVectorStyle
     );
     const canSkipFetch = await canSkipSourceUpdate({
       source: this.getSource(),

diff --git a/x-pack/plugins/maps/public/layers/layer.d.ts b/x-pack/plugins/maps/public/layers/layer.d.ts