Field Formats namespace (#56975)

* Field Formats namespace * Export IFieldFormatsRegistry and FieldFormatsRegistry separately. * remove field_formats export from data plugin and adjust lens test * Updated doc return types * Cleanup fieldFormat namespace and define it index.ts Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
elastic · Feb 10, 2020 · 09c6f25 · 09c6f25
1 parent 974a51d
commit 09c6f25
Show file tree

Hide file tree

Showing 33 changed files with 269 additions and 184 deletions.
diff --git a/src/legacy/core_plugins/data/public/search/aggs/agg_config.ts b/src/legacy/core_plugins/data/public/search/aggs/agg_config.ts
@@ -35,7 +35,7 @@ import { Schema } from './schemas';
 import {
   ISearchSource,
   FetchOptions,
-  fieldFormats,
+  FieldFormatsContentType,
   KBN_FIELD_TYPES,
 } from '../../../../../../plugins/data/public';
 
@@ -383,7 +383,7 @@ export class AggConfig {
     return this.aggConfigs.timeRange;
   }
 
-  fieldFormatter(contentType?: fieldFormats.ContentType, defaultFormat?: any) {
+  fieldFormatter(contentType?: FieldFormatsContentType, defaultFormat?: any) {
     const format = this.type && this.type.getFormat(this);
 
     if (format) {
@@ -393,7 +393,7 @@ export class AggConfig {
     return this.fieldOwnFormatter(contentType, defaultFormat);
   }
 
-  fieldOwnFormatter(contentType?: fieldFormats.ContentType, defaultFormat?: any) {
+  fieldOwnFormatter(contentType?: FieldFormatsContentType, defaultFormat?: any) {
     const fieldFormatsService = npStart.plugins.data.fieldFormats;
     const field = this.getField();
     let format = field && field.format;

diff --git a/src/legacy/core_plugins/data/public/search/aggs/agg_type.ts b/src/legacy/core_plugins/data/public/search/aggs/agg_type.ts
@@ -29,7 +29,7 @@ import { BaseParamType } from './param_types/base';
 import { AggParamType } from './param_types/agg';
 import {
   KBN_FIELD_TYPES,
-  fieldFormats,
+  IFieldFormat,
   ISearchSource,
 } from '../../../../../../plugins/data/public';
 
@@ -58,7 +58,7 @@ export interface AggTypeConfig<
     inspectorAdapters: Adapters,
     abortSignal?: AbortSignal
   ) => Promise<any>;
-  getFormat?: (agg: TAggConfig) => fieldFormats.FieldFormat;
+  getFormat?: (agg: TAggConfig) => IFieldFormat;
   getValue?: (agg: TAggConfig, bucket: any) => any;
   getKey?: (bucket: any, key: any, agg: TAggConfig) => any;
 }
@@ -199,7 +199,7 @@ export class AggType<
    * @param  {agg} agg - the agg to pick a format for
    * @return {FieldFormat}
    */
-  getFormat: (agg: TAggConfig) => fieldFormats.FieldFormat;
+  getFormat: (agg: TAggConfig) => IFieldFormat;
 
   getValue: (agg: TAggConfig, bucket: any) => any;
 

diff --git a/src/legacy/core_plugins/data/public/search/aggs/buckets/create_filter/date_range.test.ts b/src/legacy/core_plugins/data/public/search/aggs/buckets/create_filter/date_range.test.ts
@@ -19,7 +19,7 @@
 
 import moment from 'moment';
 import { createFilterDateRange } from './date_range';
-import { fieldFormats } from '../../../../../../../../plugins/data/public';
+import { fieldFormats, FieldFormatsGetConfigFn } from '../../../../../../../../plugins/data/public';
 import { AggConfigs } from '../../agg_configs';
 import { BUCKET_TYPES } from '../bucket_agg_types';
 import { IBucketAggConfig } from '../_bucket_agg_type';
@@ -28,7 +28,7 @@ jest.mock('ui/new_platform');
 
 describe('AggConfig Filters', () => {
   describe('Date range', () => {
-    const getConfig = (() => {}) as fieldFormats.GetConfigFn;
+    const getConfig = (() => {}) as FieldFormatsGetConfigFn;
     const getAggConfigs = () => {
       const field = {
         name: '@timestamp',

diff --git a/src/legacy/core_plugins/data/public/search/aggs/buckets/create_filter/histogram.test.ts b/src/legacy/core_plugins/data/public/search/aggs/buckets/create_filter/histogram.test.ts
@@ -20,13 +20,13 @@ import { createFilterHistogram } from './histogram';
 import { AggConfigs } from '../../agg_configs';
 import { BUCKET_TYPES } from '../bucket_agg_types';
 import { IBucketAggConfig } from '../_bucket_agg_type';
-import { fieldFormats } from '../../../../../../../../plugins/data/public';
+import { fieldFormats, FieldFormatsGetConfigFn } from '../../../../../../../../plugins/data/public';
 
 jest.mock('ui/new_platform');
 
 describe('AggConfig Filters', () => {
   describe('histogram', () => {
-    const getConfig = (() => {}) as fieldFormats.GetConfigFn;
+    const getConfig = (() => {}) as FieldFormatsGetConfigFn;
     const getAggConfigs = () => {
       const field = {
         name: 'bytes',

diff --git a/src/legacy/core_plugins/data/public/search/aggs/buckets/create_filter/range.test.ts b/src/legacy/core_plugins/data/public/search/aggs/buckets/create_filter/range.test.ts
@@ -18,7 +18,7 @@
  */
 
 import { createFilterRange } from './range';
-import { fieldFormats } from '../../../../../../../../plugins/data/public';
+import { fieldFormats, FieldFormatsGetConfigFn } from '../../../../../../../../plugins/data/public';
 import { AggConfigs } from '../../agg_configs';
 import { BUCKET_TYPES } from '../bucket_agg_types';
 import { IBucketAggConfig } from '../_bucket_agg_type';
@@ -27,7 +27,7 @@ jest.mock('ui/new_platform');
 
 describe('AggConfig Filters', () => {
   describe('range', () => {
-    const getConfig = (() => {}) as fieldFormats.GetConfigFn;
+    const getConfig = (() => {}) as FieldFormatsGetConfigFn;
     const getAggConfigs = () => {
       const field = {
         name: 'bytes',

diff --git a/src/legacy/core_plugins/data/public/search/aggs/buckets/range.test.ts b/src/legacy/core_plugins/data/public/search/aggs/buckets/range.test.ts
@@ -19,7 +19,7 @@
 
 import { AggConfigs } from '../agg_configs';
 import { BUCKET_TYPES } from './bucket_agg_types';
-import { fieldFormats } from '../../../../../../../plugins/data/public';
+import { FieldFormatsGetConfigFn, fieldFormats } from '../../../../../../../plugins/data/public';
 
 jest.mock('ui/new_platform');
 
@@ -44,7 +44,7 @@ const buckets = [
 ];
 
 describe('Range Agg', () => {
-  const getConfig = (() => {}) as fieldFormats.GetConfigFn;
+  const getConfig = (() => {}) as FieldFormatsGetConfigFn;
   const getAggConfigs = () => {
     const field = {
       name: 'bytes',

diff --git a/src/legacy/core_plugins/data/public/search/aggs/buckets/terms.ts b/src/legacy/core_plugins/data/public/search/aggs/buckets/terms.ts
@@ -30,7 +30,8 @@ import { IAggConfigs } from '../agg_configs';
 import { Adapters } from '../../../../../../../plugins/inspector/public';
 import {
   ISearchSource,
-  fieldFormats,
+  IFieldFormat,
+  FieldFormatsContentType,
   KBN_FIELD_TYPES,
 } from '../../../../../../../plugins/data/public';
 
@@ -80,9 +81,9 @@ export const termsBucketAgg = new BucketAggType({
     const params = agg.params;
     return agg.getFieldDisplayName() + ': ' + params.order.text;
   },
-  getFormat(bucket): fieldFormats.FieldFormat {
+  getFormat(bucket): IFieldFormat {
     return {
-      getConverterFor: (type: fieldFormats.ContentType) => {
+      getConverterFor: (type: FieldFormatsContentType) => {
         return (val: any) => {
           if (val === '__other__') {
             return bucket.params.otherBucketLabel;
@@ -94,7 +95,7 @@ export const termsBucketAgg = new BucketAggType({
           return bucket.params.field.format.convert(val, type);
         };
       },
-    } as fieldFormats.FieldFormat;
+    } as IFieldFormat;
   },
   createFilter: createFilterTerms,
   postFlightRequest: async (

diff --git a/src/legacy/core_plugins/vis_type_metric/public/components/metric_vis_component.tsx b/src/legacy/core_plugins/vis_type_metric/public/components/metric_vis_component.tsx
@@ -24,7 +24,7 @@ import { isColorDark } from '@elastic/eui';
 
 import { getFormat } from '../legacy_imports';
 import { MetricVisValue } from './metric_vis_value';
-import { fieldFormats } from '../../../../../plugins/data/public';
+import { FieldFormatsContentType, IFieldFormat } from '../../../../../plugins/data/public';
 import { Context } from '../metric_vis_fn';
 import { KibanaDatatable } from '../../../../../plugins/expressions/public';
 import { getHeatmapColors } from '../../../../../plugins/charts/public';
@@ -100,9 +100,9 @@ export class MetricVisComponent extends Component<MetricVisComponentProps> {
   }
 
   private getFormattedValue = (
-    fieldFormatter: fieldFormats.FieldFormat,
+    fieldFormatter: IFieldFormat,
     value: any,
-    format: fieldFormats.ContentType = 'text'
+    format: FieldFormatsContentType = 'text'
   ) => {
     if (isNaN(value)) return '-';
     return fieldFormatter.convert(value, format);
@@ -119,7 +119,7 @@ export class MetricVisComponent extends Component<MetricVisComponentProps> {
     const metrics: MetricVisMetric[] = [];
 
     let bucketColumnId: string;
-    let bucketFormatter: fieldFormats.FieldFormat;
+    let bucketFormatter: IFieldFormat;
 
     if (dimensions.bucket) {
       bucketColumnId = table.columns[dimensions.bucket.accessor].id;

diff --git a/src/legacy/ui/public/visualize/loader/pipeline_helpers/utilities.ts b/src/legacy/ui/public/visualize/loader/pipeline_helpers/utilities.ts
@@ -22,7 +22,12 @@ import { identity } from 'lodash';
 import { IAggConfig } from 'ui/agg_types';
 import { npStart } from 'ui/new_platform';
 import { SerializedFieldFormat } from 'src/plugins/expressions/public';
-import { fieldFormats } from '../../../../../../plugins/data/public';
+import {
+  fieldFormats,
+  IFieldFormat,
+  FieldFormatId,
+  FieldFormatsContentType,
+} from '../../../../../../plugins/data/public';
 import { Vis } from '../../../../../core_plugins/visualizations/public';
 
 import { tabifyGetColumns } from '../../../agg_response/tabify/_get_columns';
@@ -45,10 +50,7 @@ const getConfig = (key: string, defaultOverride?: any): any =>
   npStart.core.uiSettings.get(key, defaultOverride);
 const DefaultFieldFormat = fieldFormats.FieldFormat.from(identity);
 
-const getFieldFormat = (
-  id?: fieldFormats.IFieldFormatId,
-  params: object = {}
-): fieldFormats.FieldFormat => {
+const getFieldFormat = (id?: FieldFormatId, params: object = {}): IFieldFormat => {
   const fieldFormatsService = npStart.plugins.data.fieldFormats;
 
   if (id) {
@@ -94,7 +96,7 @@ export const createFormat = (agg: IAggConfig): SerializedFieldFormat => {
   return formats[agg.type.name] ? formats[agg.type.name]() : format;
 };
 
-export type FormatFactory = (mapping?: SerializedFieldFormat) => fieldFormats.FieldFormat;
+export type FormatFactory = (mapping?: SerializedFieldFormat) => IFieldFormat;
 
 export const getFormat: FormatFactory = mapping => {
   if (!mapping) {
@@ -133,7 +135,7 @@ export const getFormat: FormatFactory = mapping => {
     return new IpRangeFormat();
   } else if (isTermsFieldFormat(mapping) && mapping.params) {
     const { params } = mapping;
-    const convert = (val: string, type: fieldFormats.ContentType) => {
+    const convert = (val: string, type: FieldFormatsContentType) => {
       const format = getFieldFormat(params.id, mapping.params);
 
       if (val === '__other__') {
@@ -148,8 +150,8 @@ export const getFormat: FormatFactory = mapping => {
 
     return {
       convert,
-      getConverterFor: (type: fieldFormats.ContentType) => (val: string) => convert(val, type),
-    } as fieldFormats.FieldFormat;
+      getConverterFor: (type: FieldFormatsContentType) => (val: string) => convert(val, type),
+    } as IFieldFormat;
   } else {
     return getFieldFormat(id, mapping.params);
   }

diff --git a/src/plugins/data/common/field_formats/content_types/html_content_type.ts b/src/plugins/data/common/field_formats/content_types/html_content_type.ts
@@ -17,10 +17,10 @@
  * under the License.
  */
 import { escape, isFunction } from 'lodash';
-import { IFieldFormat, HtmlContextTypeConvert } from '../types';
+import { IFieldFormat, HtmlContextTypeConvert, FieldFormatsContentType } from '../types';
 import { asPrettyString, getHighlightHtml } from '../utils';
 
-export const HTML_CONTEXT_TYPE = 'html';
+export const HTML_CONTEXT_TYPE: FieldFormatsContentType = 'html';
 
 const getConvertFn = (
   format: IFieldFormat,

diff --git a/src/plugins/data/common/field_formats/content_types/text_content_type.ts b/src/plugins/data/common/field_formats/content_types/text_content_type.ts
@@ -18,10 +18,10 @@
  */
 
 import { isFunction } from 'lodash';
-import { IFieldFormat, TextContextTypeConvert } from '../types';
+import { IFieldFormat, TextContextTypeConvert, FieldFormatsContentType } from '../types';
 import { asPrettyString } from '../utils';
 
-export const TEXT_CONTEXT_TYPE = 'text';
+export const TEXT_CONTEXT_TYPE: FieldFormatsContentType = 'text';
 
 export const setup = (
   format: IFieldFormat,

diff --git a/src/plugins/data/common/field_formats/converters/date_server.ts b/src/plugins/data/common/field_formats/converters/date_server.ts
@@ -25,7 +25,7 @@ import { FieldFormat } from '../field_format';
 import {
   TextContextTypeConvert,
   FIELD_FORMAT_IDS,
-  GetConfigFn,
+  FieldFormatsGetConfigFn,
   IFieldFormatMetaParams,
 } from '../types';
 
@@ -40,7 +40,7 @@ export class DateFormat extends FieldFormat {
   private memoizedPattern: string = '';
   private timeZone: string = '';
 
-  constructor(params: IFieldFormatMetaParams, getConfig?: GetConfigFn) {
+  constructor(params: IFieldFormatMetaParams, getConfig?: FieldFormatsGetConfigFn) {
     super(params, getConfig);
 
     this.memoizedConverter = memoize((val: any) => {

diff --git a/src/plugins/data/common/field_formats/field_format.ts b/src/plugins/data/common/field_formats/field_format.ts
@@ -20,21 +20,16 @@
 import { transform, size, cloneDeep, get, defaults } from 'lodash';
 import { createCustomFieldFormat } from './converters/custom';
 import {
-  GetConfigFn,
-  ContentType,
+  FieldFormatsGetConfigFn,
+  FieldFormatsContentType,
   IFieldFormatType,
   FieldFormatConvert,
   FieldFormatConvertFunction,
   HtmlContextTypeOptions,
   TextContextTypeOptions,
   IFieldFormatMetaParams,
 } from './types';
-import {
-  htmlContentTypeSetup,
-  textContentTypeSetup,
-  TEXT_CONTEXT_TYPE,
-  HTML_CONTEXT_TYPE,
-} from './content_types';
+import { htmlContentTypeSetup, textContentTypeSetup, TEXT_CONTEXT_TYPE } from './content_types';
 import { HtmlContextTypeConvert, TextContextTypeConvert } from './types';
 
 const DEFAULT_CONTEXT_TYPE = TEXT_CONTEXT_TYPE;
@@ -90,9 +85,9 @@ export abstract class FieldFormat {
   public type: any = this.constructor;
 
   protected readonly _params: any;
-  protected getConfig: GetConfigFn | undefined;
+  protected getConfig: FieldFormatsGetConfigFn | undefined;
 
-  constructor(_params: IFieldFormatMetaParams = {}, getConfig?: GetConfigFn) {
+  constructor(_params: IFieldFormatMetaParams = {}, getConfig?: FieldFormatsGetConfigFn) {
     this._params = _params;
 
     if (getConfig) {
@@ -112,7 +107,7 @@ export abstract class FieldFormat {
    */
   convert(
     value: any,
-    contentType: ContentType = DEFAULT_CONTEXT_TYPE,
+    contentType: FieldFormatsContentType = DEFAULT_CONTEXT_TYPE,
     options?: HtmlContextTypeOptions | TextContextTypeOptions
   ): string {
     const converter = this.getConverterFor(contentType);
@@ -131,7 +126,7 @@ export abstract class FieldFormat {
    * @public
    */
   getConverterFor(
-    contentType: ContentType = DEFAULT_CONTEXT_TYPE
+    contentType: FieldFormatsContentType = DEFAULT_CONTEXT_TYPE
   ): FieldFormatConvertFunction | null {
     if (!this.convertObject) {
       this.convertObject = this.setupContentType();
@@ -210,8 +205,8 @@ export abstract class FieldFormat {
 
   setupContentType(): FieldFormatConvert {
     return {
-      [TEXT_CONTEXT_TYPE]: textContentTypeSetup(this, this.textConvert),
-      [HTML_CONTEXT_TYPE]: htmlContentTypeSetup(this, this.htmlConvert),
+      text: textContentTypeSetup(this, this.textConvert),
+      html: htmlContentTypeSetup(this, this.htmlConvert),
     };
   }
 

diff --git a/src/plugins/data/common/field_formats/field_formats_registry.test.ts b/src/plugins/data/common/field_formats/field_formats_registry.test.ts
@@ -18,15 +18,15 @@
  */
 import { FieldFormatsRegistry } from './field_formats_registry';
 import { BoolFormat, PercentFormat, StringFormat } from './converters';
-import { GetConfigFn, IFieldFormatType } from './types';
+import { FieldFormatsGetConfigFn, IFieldFormatType } from './types';
 import { KBN_FIELD_TYPES } from '../../common';
 
 const getValueOfPrivateField = (instance: any, field: string) => instance[field];
 
 describe('FieldFormatsRegistry', () => {
   let fieldFormatsRegistry: FieldFormatsRegistry;
   let defaultMap = {};
-  const getConfig = (() => defaultMap) as GetConfigFn;
+  const getConfig = (() => defaultMap) as FieldFormatsGetConfigFn;
 
   beforeEach(() => {
     fieldFormatsRegistry = new FieldFormatsRegistry();