diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.castestokbnfieldtypename.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.castestokbnfieldtypename.md index a3914a54decb3..a90c0477e57fb 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.castestokbnfieldtypename.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.castestokbnfieldtypename.md @@ -4,10 +4,13 @@ ## castEsToKbnFieldTypeName variable -Get the KbnFieldType name for an esType string +> Warning: This API is now obsolete. +> +> import from "@kbn/field-types" instead +> Signature: ```typescript -castEsToKbnFieldTypeName: (esType: ES_FIELD_TYPES | string) => KBN_FIELD_TYPES +castEsToKbnFieldTypeName: (esType: string) => import("@kbn/field-types").KBN_FIELD_TYPES ``` diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md deleted file mode 100644 index 61929355decc2..0000000000000 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.es_field_types.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [ES\_FIELD\_TYPES](./kibana-plugin-plugins-data-public.es_field_types.md) - -## ES\_FIELD\_TYPES enum - -\* - -Signature: - -```typescript -export declare enum ES_FIELD_TYPES -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| \_ID | "_id" | | -| \_INDEX | "_index" | | -| \_SOURCE | "_source" | | -| \_TYPE | "_type" | | -| ATTACHMENT | "attachment" | | -| BOOLEAN | "boolean" | | -| BYTE | "byte" | | -| DATE | "date" | | -| DATE\_NANOS | "date_nanos" | | -| DATE\_RANGE | "date_range" | | -| DOUBLE | "double" | | -| DOUBLE\_RANGE | "double_range" | | -| FLOAT | "float" | | -| FLOAT\_RANGE | "float_range" | | -| GEO\_POINT | "geo_point" | | -| GEO\_SHAPE | "geo_shape" | | -| HALF\_FLOAT | "half_float" | | -| HISTOGRAM | "histogram" | | -| INTEGER | "integer" | | -| INTEGER\_RANGE | "integer_range" | | -| IP | "ip" | | -| IP\_RANGE | "ip_range" | | -| KEYWORD | "keyword" | | -| LONG | "long" | | -| LONG\_RANGE | "long_range" | | -| MURMUR3 | "murmur3" | | -| NESTED | "nested" | | -| OBJECT | "object" | | -| SCALED\_FLOAT | "scaled_float" | | -| SHORT | "short" | | -| STRING | "string" | | -| TEXT | "text" | | -| TOKEN\_COUNT | "token_count" | | -| UNSIGNED\_LONG | "unsigned_long" | | -| VERSION | "version" | | - diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getkbntypenames.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getkbntypenames.md index 57ea5bab6e8c3..eda4b141ec2cd 100644 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getkbntypenames.md +++ b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.getkbntypenames.md @@ -4,9 +4,10 @@ ## getKbnTypeNames variable -Get the esTypes known by all kbnFieldTypes - - {Array} +> Warning: This API is now obsolete. +> +> import from "@kbn/field-types" instead +> Signature: diff --git a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kbn_field_types.md b/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kbn_field_types.md deleted file mode 100644 index 521ceeb1e37f2..0000000000000 --- a/docs/development/plugins/data/public/kibana-plugin-plugins-data-public.kbn_field_types.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) > [KBN\_FIELD\_TYPES](./kibana-plugin-plugins-data-public.kbn_field_types.md) - -## KBN\_FIELD\_TYPES enum - -\* - -Signature: - -```typescript -export declare enum KBN_FIELD_TYPES -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| \_SOURCE | "_source" | | -| ATTACHMENT | "attachment" | | -| BOOLEAN | "boolean" | | -| CONFLICT | "conflict" | | -| DATE | "date" | | -| DATE\_RANGE | "date_range" | | -| GEO\_POINT | "geo_point" | | -| GEO\_SHAPE | "geo_shape" | | -| HISTOGRAM | "histogram" | | -| IP | "ip" | | -| IP\_RANGE | "ip_range" | | -| MISSING | "missing" | | -| MURMUR3 | "murmur3" | | -| NESTED | "nested" | | -| NUMBER | "number" | | -| NUMBER\_RANGE | "number_range" | | -| OBJECT | "object" | | -| STRING | "string" | | -| UNKNOWN | "unknown" | | - diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.castestokbnfieldtypename.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.castestokbnfieldtypename.md index ea009601acdff..037c938415978 100644 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.castestokbnfieldtypename.md +++ b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.castestokbnfieldtypename.md @@ -4,10 +4,13 @@ ## castEsToKbnFieldTypeName variable -Get the KbnFieldType name for an esType string +> Warning: This API is now obsolete. +> +> import from "@kbn/field-types" instead +> Signature: ```typescript -castEsToKbnFieldTypeName: (esType: ES_FIELD_TYPES | string) => KBN_FIELD_TYPES +castEsToKbnFieldTypeName: (esType: string) => import("@kbn/field-types").KBN_FIELD_TYPES ``` diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md deleted file mode 100644 index 5061e3e97a346..0000000000000 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.es_field_types.md +++ /dev/null @@ -1,54 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [ES\_FIELD\_TYPES](./kibana-plugin-plugins-data-server.es_field_types.md) - -## ES\_FIELD\_TYPES enum - -\* - -Signature: - -```typescript -export declare enum ES_FIELD_TYPES -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| \_ID | "_id" | | -| \_INDEX | "_index" | | -| \_SOURCE | "_source" | | -| \_TYPE | "_type" | | -| ATTACHMENT | "attachment" | | -| BOOLEAN | "boolean" | | -| BYTE | "byte" | | -| DATE | "date" | | -| DATE\_NANOS | "date_nanos" | | -| DATE\_RANGE | "date_range" | | -| DOUBLE | "double" | | -| DOUBLE\_RANGE | "double_range" | | -| FLOAT | "float" | | -| FLOAT\_RANGE | "float_range" | | -| GEO\_POINT | "geo_point" | | -| GEO\_SHAPE | "geo_shape" | | -| HALF\_FLOAT | "half_float" | | -| HISTOGRAM | "histogram" | | -| INTEGER | "integer" | | -| INTEGER\_RANGE | "integer_range" | | -| IP | "ip" | | -| IP\_RANGE | "ip_range" | | -| KEYWORD | "keyword" | | -| LONG | "long" | | -| LONG\_RANGE | "long_range" | | -| MURMUR3 | "murmur3" | | -| NESTED | "nested" | | -| OBJECT | "object" | | -| SCALED\_FLOAT | "scaled_float" | | -| SHORT | "short" | | -| STRING | "string" | | -| TEXT | "text" | | -| TOKEN\_COUNT | "token_count" | | -| UNSIGNED\_LONG | "unsigned_long" | | -| VERSION | "version" | | - diff --git a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kbn_field_types.md b/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kbn_field_types.md deleted file mode 100644 index 40fa872ff0fc6..0000000000000 --- a/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.kbn_field_types.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) > [KBN\_FIELD\_TYPES](./kibana-plugin-plugins-data-server.kbn_field_types.md) - -## KBN\_FIELD\_TYPES enum - -\* - -Signature: - -```typescript -export declare enum KBN_FIELD_TYPES -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| \_SOURCE | "_source" | | -| ATTACHMENT | "attachment" | | -| BOOLEAN | "boolean" | | -| CONFLICT | "conflict" | | -| DATE | "date" | | -| DATE\_RANGE | "date_range" | | -| GEO\_POINT | "geo_point" | | -| GEO\_SHAPE | "geo_shape" | | -| HISTOGRAM | "histogram" | | -| IP | "ip" | | -| IP\_RANGE | "ip_range" | | -| MISSING | "missing" | | -| MURMUR3 | "murmur3" | | -| NESTED | "nested" | | -| NUMBER | "number" | | -| NUMBER\_RANGE | "number_range" | | -| OBJECT | "object" | | -| STRING | "string" | | -| UNKNOWN | "unknown" | | - diff --git a/package.json b/package.json index a629c8a211468..07d18bc65b710 100644 --- a/package.json +++ b/package.json @@ -127,6 +127,7 @@ "@kbn/config-schema": "link:bazel-bin/packages/kbn-config-schema", "@kbn/crypto": "link:bazel-bin/packages/kbn-crypto", "@kbn/es-query": "link:bazel-bin/packages/kbn-es-query", + "@kbn/field-types": "link:bazel-bin/packages/kbn-field-types", "@kbn/i18n": "link:bazel-bin/packages/kbn-i18n", "@kbn/interpreter": "link:bazel-bin/packages/kbn-interpreter", "@kbn/io-ts-utils": "link:bazel-bin/packages/kbn-io-ts-utils", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index 778a7c7a0f2d4..fcadedf8630f1 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -25,6 +25,7 @@ filegroup( "//packages/kbn-eslint-import-resolver-kibana:build", "//packages/kbn-eslint-plugin-eslint:build", "//packages/kbn-expect:build", + "//packages/kbn-field-types:build", "//packages/kbn-i18n:build", "//packages/kbn-interpreter:build", "//packages/kbn-io-ts-utils:build", diff --git a/packages/kbn-field-types/.babelrc b/packages/kbn-field-types/.babelrc new file mode 100644 index 0000000000000..7da72d1779128 --- /dev/null +++ b/packages/kbn-field-types/.babelrc @@ -0,0 +1,3 @@ +{ + "presets": ["@kbn/babel-preset/node_preset"] +} diff --git a/packages/kbn-field-types/BUILD.bazel b/packages/kbn-field-types/BUILD.bazel new file mode 100644 index 0000000000000..829a1b11a0db7 --- /dev/null +++ b/packages/kbn-field-types/BUILD.bazel @@ -0,0 +1,96 @@ + +load("@npm//@bazel/typescript:index.bzl", "ts_config", "ts_project") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library", "pkg_npm") +load("//src/dev/bazel:index.bzl", "jsts_transpiler") + +PKG_BASE_NAME = "kbn-field-types" +PKG_REQUIRE_NAME = "@kbn/field-types" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", + "README.md" +] + +RUNTIME_DEPS = [ + "@npm//jest-styled-components", + "@npm//node-forge", +] + +TYPES_DEPS = [ + "@npm//@types/flot", + "@npm//@types/jest", + "@npm//@types/node", + "@npm//@types/node-forge", + "@npm//@types/testing-library__jest-dom", + "@npm//resize-observer-polyfill", + "@npm//@emotion/react", + "@npm//jest-styled-components", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), + ) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + incremental = False, + out_dir = "target_types", + source_map = True, + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_BASE_NAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":tsc_types"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [ + ":%s" % PKG_BASE_NAME, + ] +) + +filegroup( + name = "build", + srcs = [ + ":npm_module", + ], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-field-types/README.md b/packages/kbn-field-types/README.md new file mode 100644 index 0000000000000..b0cd985cede5d --- /dev/null +++ b/packages/kbn-field-types/README.md @@ -0,0 +1,3 @@ +# @kbn/field-types + +Types and utilities for kbn and es field types diff --git a/packages/kbn-field-types/jest.config.js b/packages/kbn-field-types/jest.config.js new file mode 100644 index 0000000000000..f933c41d3cd64 --- /dev/null +++ b/packages/kbn-field-types/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-field-types'], +}; diff --git a/packages/kbn-field-types/package.json b/packages/kbn-field-types/package.json new file mode 100644 index 0000000000000..c56463e108150 --- /dev/null +++ b/packages/kbn-field-types/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/field-types", + "version": "1.0.0", + "private": true, + "license": "SSPL-1.0 OR Elastic License 2.0", + "main": "./target_node/index.js", + "types": "./target_types/index.d.ts" +} diff --git a/packages/kbn-field-types/src/index.ts b/packages/kbn-field-types/src/index.ts new file mode 100644 index 0000000000000..77a2e96367d6f --- /dev/null +++ b/packages/kbn-field-types/src/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { KbnFieldType } from './kbn_field_type'; + +export { + castEsToKbnFieldTypeName, + getKbnFieldType, + getKbnTypeNames, + getFilterableKbnTypeNames, +} from './kbn_field_types'; + +export { KBN_FIELD_TYPES, ES_FIELD_TYPES, KbnFieldTypeOptions } from './types'; diff --git a/src/plugins/data/common/kbn_field_types/kbn_field_type.ts b/packages/kbn-field-types/src/kbn_field_type.ts similarity index 100% rename from src/plugins/data/common/kbn_field_types/kbn_field_type.ts rename to packages/kbn-field-types/src/kbn_field_type.ts diff --git a/src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts b/packages/kbn-field-types/src/kbn_field_types.test.ts similarity index 100% rename from src/plugins/data/common/kbn_field_types/kbn_field_types.test.ts rename to packages/kbn-field-types/src/kbn_field_types.test.ts diff --git a/src/plugins/data/common/kbn_field_types/kbn_field_types.ts b/packages/kbn-field-types/src/kbn_field_types.ts similarity index 100% rename from src/plugins/data/common/kbn_field_types/kbn_field_types.ts rename to packages/kbn-field-types/src/kbn_field_types.ts diff --git a/src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts b/packages/kbn-field-types/src/kbn_field_types_factory.ts similarity index 100% rename from src/plugins/data/common/kbn_field_types/kbn_field_types_factory.ts rename to packages/kbn-field-types/src/kbn_field_types_factory.ts diff --git a/packages/kbn-field-types/src/types.ts b/packages/kbn-field-types/src/types.ts new file mode 100644 index 0000000000000..c14e7e4b03661 --- /dev/null +++ b/packages/kbn-field-types/src/types.ts @@ -0,0 +1,85 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** @public **/ +export interface KbnFieldTypeOptions { + sortable: boolean; + filterable: boolean; + name: string; + esTypes: ES_FIELD_TYPES[]; +} + +/** @public **/ +export enum ES_FIELD_TYPES { + _ID = '_id', + _INDEX = '_index', + _SOURCE = '_source', + _TYPE = '_type', + + STRING = 'string', + TEXT = 'text', + KEYWORD = 'keyword', + VERSION = 'version', + + BOOLEAN = 'boolean', + OBJECT = 'object', + + DATE = 'date', + DATE_NANOS = 'date_nanos', + DATE_RANGE = 'date_range', + + GEO_POINT = 'geo_point', + GEO_SHAPE = 'geo_shape', + + FLOAT = 'float', + HALF_FLOAT = 'half_float', + SCALED_FLOAT = 'scaled_float', + DOUBLE = 'double', + INTEGER = 'integer', + LONG = 'long', + SHORT = 'short', + UNSIGNED_LONG = 'unsigned_long', + + FLOAT_RANGE = 'float_range', + DOUBLE_RANGE = 'double_range', + INTEGER_RANGE = 'integer_range', + LONG_RANGE = 'long_range', + + NESTED = 'nested', + BYTE = 'byte', + IP = 'ip', + IP_RANGE = 'ip_range', + ATTACHMENT = 'attachment', + TOKEN_COUNT = 'token_count', + MURMUR3 = 'murmur3', + + HISTOGRAM = 'histogram', +} + +/** @public **/ +export enum KBN_FIELD_TYPES { + _SOURCE = '_source', + ATTACHMENT = 'attachment', + BOOLEAN = 'boolean', + DATE = 'date', + DATE_RANGE = 'date_range', + GEO_POINT = 'geo_point', + GEO_SHAPE = 'geo_shape', + IP = 'ip', + IP_RANGE = 'ip_range', + MURMUR3 = 'murmur3', + NUMBER = 'number', + NUMBER_RANGE = 'number_range', + STRING = 'string', + UNKNOWN = 'unknown', + CONFLICT = 'conflict', + OBJECT = 'object', + NESTED = 'nested', + HISTOGRAM = 'histogram', + MISSING = 'missing', +} diff --git a/packages/kbn-field-types/tsconfig.json b/packages/kbn-field-types/tsconfig.json new file mode 100644 index 0000000000000..a7270134039be --- /dev/null +++ b/packages/kbn-field-types/tsconfig.json @@ -0,0 +1,14 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "incremental": false, + "outDir": "./target_types", + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "rootDir": "src", + "sourceMap": true, + "sourceRoot": "../../../../packages/kbn-field-types/src" + }, + "include": ["src/**/*"] +} diff --git a/src/plugins/data/common/field_formats/converters/boolean.ts b/src/plugins/data/common/field_formats/converters/boolean.ts index 6a19dc70250e6..d70501bf0f9d5 100644 --- a/src/plugins/data/common/field_formats/converters/boolean.ts +++ b/src/plugins/data/common/field_formats/converters/boolean.ts @@ -7,7 +7,7 @@ */ import { i18n } from '@kbn/i18n'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; import { asPrettyString } from '../utils'; diff --git a/src/plugins/data/common/field_formats/converters/color.tsx b/src/plugins/data/common/field_formats/converters/color.tsx index 98f25fdf81811..f653c6a4f82a2 100644 --- a/src/plugins/data/common/field_formats/converters/color.tsx +++ b/src/plugins/data/common/field_formats/converters/color.tsx @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; import React from 'react'; import ReactDOM from 'react-dom/server'; import { findLast, cloneDeep, escape } from 'lodash'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { HtmlContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; import { asPrettyString } from '../utils'; diff --git a/src/plugins/data/common/field_formats/converters/duration.ts b/src/plugins/data/common/field_formats/converters/duration.ts index 71ac022ba5e5c..926f907af8fe9 100644 --- a/src/plugins/data/common/field_formats/converters/duration.ts +++ b/src/plugins/data/common/field_formats/converters/duration.ts @@ -8,7 +8,7 @@ import { i18n } from '@kbn/i18n'; import moment, { unitOfTime, Duration } from 'moment'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; diff --git a/src/plugins/data/common/field_formats/converters/histogram.ts b/src/plugins/data/common/field_formats/converters/histogram.ts index 9f6b8c5cfd1da..0812dcc795dc9 100644 --- a/src/plugins/data/common/field_formats/converters/histogram.ts +++ b/src/plugins/data/common/field_formats/converters/histogram.ts @@ -7,8 +7,8 @@ */ import { i18n } from '@kbn/i18n'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; import { BytesFormat } from './bytes'; import { NumberFormat } from './number'; diff --git a/src/plugins/data/common/field_formats/converters/ip.ts b/src/plugins/data/common/field_formats/converters/ip.ts index d64c9bddf1558..76fe4404e2418 100644 --- a/src/plugins/data/common/field_formats/converters/ip.ts +++ b/src/plugins/data/common/field_formats/converters/ip.ts @@ -7,7 +7,7 @@ */ import { i18n } from '@kbn/i18n'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; diff --git a/src/plugins/data/common/field_formats/converters/numeral.ts b/src/plugins/data/common/field_formats/converters/numeral.ts index 12c10f54357dd..9d8b7ba1c369d 100644 --- a/src/plugins/data/common/field_formats/converters/numeral.ts +++ b/src/plugins/data/common/field_formats/converters/numeral.ts @@ -10,7 +10,7 @@ import numeral from '@elastic/numeral'; // @ts-ignore import numeralLanguages from '@elastic/numeral/languages'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert } from '../types'; import { UI_SETTINGS } from '../../constants'; diff --git a/src/plugins/data/common/field_formats/converters/relative_date.ts b/src/plugins/data/common/field_formats/converters/relative_date.ts index 5792bada7686e..c54e32452f267 100644 --- a/src/plugins/data/common/field_formats/converters/relative_date.ts +++ b/src/plugins/data/common/field_formats/converters/relative_date.ts @@ -8,7 +8,7 @@ import { i18n } from '@kbn/i18n'; import moment from 'moment'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; diff --git a/src/plugins/data/common/field_formats/converters/source.tsx b/src/plugins/data/common/field_formats/converters/source.tsx index d6176b321f3f3..de77736503f86 100644 --- a/src/plugins/data/common/field_formats/converters/source.tsx +++ b/src/plugins/data/common/field_formats/converters/source.tsx @@ -9,8 +9,8 @@ import React, { Fragment } from 'react'; import ReactDOM from 'react-dom/server'; import { escape, keys } from 'lodash'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { shortenDottedString } from '../../utils'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, HtmlContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; import { UI_SETTINGS } from '../../constants'; diff --git a/src/plugins/data/common/field_formats/converters/static_lookup.ts b/src/plugins/data/common/field_formats/converters/static_lookup.ts index 17ce902a8a18b..63d3506dda0bb 100644 --- a/src/plugins/data/common/field_formats/converters/static_lookup.ts +++ b/src/plugins/data/common/field_formats/converters/static_lookup.ts @@ -7,7 +7,7 @@ */ import { i18n } from '@kbn/i18n'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; diff --git a/src/plugins/data/common/field_formats/converters/string.ts b/src/plugins/data/common/field_formats/converters/string.ts index 28dd714abaf41..816754a2a9298 100644 --- a/src/plugins/data/common/field_formats/converters/string.ts +++ b/src/plugins/data/common/field_formats/converters/string.ts @@ -8,8 +8,8 @@ import escape from 'lodash/escape'; import { i18n } from '@kbn/i18n'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { asPrettyString, getHighlightHtml } from '../utils'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS, HtmlContextTypeConvert } from '../types'; import { shortenDottedString } from '../../utils'; diff --git a/src/plugins/data/common/field_formats/converters/truncate.ts b/src/plugins/data/common/field_formats/converters/truncate.ts index 9fa0272cb59b0..4c68a4c056b82 100644 --- a/src/plugins/data/common/field_formats/converters/truncate.ts +++ b/src/plugins/data/common/field_formats/converters/truncate.ts @@ -8,7 +8,7 @@ import { i18n } from '@kbn/i18n'; import { truncate } from 'lodash'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types'; diff --git a/src/plugins/data/common/field_formats/converters/url.ts b/src/plugins/data/common/field_formats/converters/url.ts index 83b39c5000b09..862efa307ee74 100644 --- a/src/plugins/data/common/field_formats/converters/url.ts +++ b/src/plugins/data/common/field_formats/converters/url.ts @@ -8,8 +8,8 @@ import { i18n } from '@kbn/i18n'; import { escape, memoize } from 'lodash'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { getHighlightHtml } from '../utils'; -import { KBN_FIELD_TYPES } from '../../kbn_field_types/types'; import { FieldFormat } from '../field_format'; import { TextContextTypeConvert, diff --git a/src/plugins/data/common/field_formats/field_formats_registry.ts b/src/plugins/data/common/field_formats/field_formats_registry.ts index 996cf05a9faa9..9e96f5cc1a6bd 100644 --- a/src/plugins/data/common/field_formats/field_formats_registry.ts +++ b/src/plugins/data/common/field_formats/field_formats_registry.ts @@ -8,6 +8,7 @@ // eslint-disable-next-line max-classes-per-file import { forOwn, isFunction, memoize, identity } from 'lodash'; +import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types'; import { FieldFormatsGetConfigFn, @@ -20,7 +21,6 @@ import { import { baseFormatters } from './constants/base_formatters'; import { FieldFormat } from './field_format'; import { FormatFactory } from './utils'; -import { ES_FIELD_TYPES, KBN_FIELD_TYPES } from '../kbn_field_types/types'; import { UI_SETTINGS } from '../constants'; import { FieldFormatNotFoundError } from '../field_formats'; import { SerializedFieldFormat } from '../../../expressions/common/types'; diff --git a/src/plugins/data/common/kbn_field_types/index.ts b/src/plugins/data/common/kbn_field_types/index.ts index 0a19a7f91f923..69ee9737d0f80 100644 --- a/src/plugins/data/common/kbn_field_types/index.ts +++ b/src/plugins/data/common/kbn_field_types/index.ts @@ -6,11 +6,43 @@ * Side Public License, v 1. */ -export { KbnFieldType } from './kbn_field_type'; +// NOTE: trick to mark exports as deprecated (only for constants and types, but not for interfaces, classes or enums) +import { + castEsToKbnFieldTypeName as oldCastEsToKbnFieldTypeName, + getFilterableKbnTypeNames as oldGetFilterableKbnTypeNames, + getKbnFieldType as oldGetKbnFieldType, + getKbnTypeNames as oldGetKbnTypeNames, + KbnFieldType, +} from '@kbn/field-types'; + +/** + * @deprecated Import from the "@kbn/field-types" package directly instead. + * @removeBy 8.0 + */ +const castEsToKbnFieldTypeName = oldCastEsToKbnFieldTypeName; + +/** + * @deprecated Import from the "@kbn/field-types" package directly instead. + * @removeBy 8.0 + */ +const getFilterableKbnTypeNames = oldGetFilterableKbnTypeNames; + +/** + * @deprecated Import from the "@kbn/field-types" package directly instead. + * @removeBy 8.0 + */ +const getKbnFieldType = oldGetKbnFieldType; + +/** + * @deprecated Import from the "@kbn/field-types" package directly instead. + * @removeBy 8.0 + */ +const getKbnTypeNames = oldGetKbnTypeNames; export { castEsToKbnFieldTypeName, getKbnFieldType, getKbnTypeNames, getFilterableKbnTypeNames, -} from './kbn_field_types'; + KbnFieldType, +}; diff --git a/src/plugins/data/common/kbn_field_types/types.ts b/src/plugins/data/common/kbn_field_types/types.ts index c14e7e4b03661..cea35a53e9da1 100644 --- a/src/plugins/data/common/kbn_field_types/types.ts +++ b/src/plugins/data/common/kbn_field_types/types.ts @@ -6,80 +6,6 @@ * Side Public License, v 1. */ -/** @public **/ -export interface KbnFieldTypeOptions { - sortable: boolean; - filterable: boolean; - name: string; - esTypes: ES_FIELD_TYPES[]; -} +import { KbnFieldTypeOptions, ES_FIELD_TYPES, KBN_FIELD_TYPES } from '@kbn/field-types'; -/** @public **/ -export enum ES_FIELD_TYPES { - _ID = '_id', - _INDEX = '_index', - _SOURCE = '_source', - _TYPE = '_type', - - STRING = 'string', - TEXT = 'text', - KEYWORD = 'keyword', - VERSION = 'version', - - BOOLEAN = 'boolean', - OBJECT = 'object', - - DATE = 'date', - DATE_NANOS = 'date_nanos', - DATE_RANGE = 'date_range', - - GEO_POINT = 'geo_point', - GEO_SHAPE = 'geo_shape', - - FLOAT = 'float', - HALF_FLOAT = 'half_float', - SCALED_FLOAT = 'scaled_float', - DOUBLE = 'double', - INTEGER = 'integer', - LONG = 'long', - SHORT = 'short', - UNSIGNED_LONG = 'unsigned_long', - - FLOAT_RANGE = 'float_range', - DOUBLE_RANGE = 'double_range', - INTEGER_RANGE = 'integer_range', - LONG_RANGE = 'long_range', - - NESTED = 'nested', - BYTE = 'byte', - IP = 'ip', - IP_RANGE = 'ip_range', - ATTACHMENT = 'attachment', - TOKEN_COUNT = 'token_count', - MURMUR3 = 'murmur3', - - HISTOGRAM = 'histogram', -} - -/** @public **/ -export enum KBN_FIELD_TYPES { - _SOURCE = '_source', - ATTACHMENT = 'attachment', - BOOLEAN = 'boolean', - DATE = 'date', - DATE_RANGE = 'date_range', - GEO_POINT = 'geo_point', - GEO_SHAPE = 'geo_shape', - IP = 'ip', - IP_RANGE = 'ip_range', - MURMUR3 = 'murmur3', - NUMBER = 'number', - NUMBER_RANGE = 'number_range', - STRING = 'string', - UNKNOWN = 'unknown', - CONFLICT = 'conflict', - OBJECT = 'object', - NESTED = 'nested', - HISTOGRAM = 'histogram', - MISSING = 'missing', -} +export { KbnFieldTypeOptions, ES_FIELD_TYPES, KBN_FIELD_TYPES }; diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md index 90b1c28474ddb..f4c3d71d82e84 100644 --- a/src/plugins/data/public/public.api.md +++ b/src/plugins/data/public/public.api.md @@ -26,6 +26,7 @@ import { DetailedPeerCertificate } from 'tls'; import { Ensure } from '@kbn/utility-types'; import { EnvironmentMode } from '@kbn/config'; import { ErrorToastOptions } from 'src/core/public/notifications'; +import { ES_FIELD_TYPES } from '@kbn/field-types'; import { EsQueryConfig as EsQueryConfig_2 } from '@kbn/es-query'; import { estypes } from '@elastic/elasticsearch'; import { EuiBreadcrumb } from '@elastic/eui'; @@ -60,6 +61,7 @@ import { ISearchOptions as ISearchOptions_2 } from 'src/plugins/data/public'; import { ISearchSource as ISearchSource_2 } from 'src/plugins/data/public'; import { IStorageWrapper } from 'src/plugins/kibana_utils/public'; import { IUiSettingsClient } from 'src/core/public'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { KibanaClient } from '@elastic/elasticsearch/api/kibana'; import { KibanaExecutionContext } from 'src/core/public'; import { KueryNode as KueryNode_3 } from '@kbn/es-query'; @@ -608,8 +610,8 @@ export enum BUCKET_TYPES { // Warning: (ae-missing-release-tag) "castEsToKbnFieldTypeName" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public -export const castEsToKbnFieldTypeName: (esType: ES_FIELD_TYPES | string) => KBN_FIELD_TYPES; +// @public @deprecated (undocumented) +export const castEsToKbnFieldTypeName: (esType: string) => import("@kbn/field-types").KBN_FIELD_TYPES; // Warning: (ae-forgotten-export) The symbol "QuerySetup" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "BaseStateContainer" needs to be exported by the entry point index.d.ts @@ -715,79 +717,7 @@ export class DuplicateIndexPatternError extends Error { constructor(message: string); } -// @public (undocumented) -export enum ES_FIELD_TYPES { - // (undocumented) - ATTACHMENT = "attachment", - // (undocumented) - BOOLEAN = "boolean", - // (undocumented) - BYTE = "byte", - // (undocumented) - DATE = "date", - // (undocumented) - DATE_NANOS = "date_nanos", - // (undocumented) - DATE_RANGE = "date_range", - // (undocumented) - DOUBLE = "double", - // (undocumented) - DOUBLE_RANGE = "double_range", - // (undocumented) - FLOAT = "float", - // (undocumented) - FLOAT_RANGE = "float_range", - // (undocumented) - GEO_POINT = "geo_point", - // (undocumented) - GEO_SHAPE = "geo_shape", - // (undocumented) - HALF_FLOAT = "half_float", - // (undocumented) - HISTOGRAM = "histogram", - // (undocumented) - _ID = "_id", - // (undocumented) - _INDEX = "_index", - // (undocumented) - INTEGER = "integer", - // (undocumented) - INTEGER_RANGE = "integer_range", - // (undocumented) - IP = "ip", - // (undocumented) - IP_RANGE = "ip_range", - // (undocumented) - KEYWORD = "keyword", - // (undocumented) - LONG = "long", - // (undocumented) - LONG_RANGE = "long_range", - // (undocumented) - MURMUR3 = "murmur3", - // (undocumented) - NESTED = "nested", - // (undocumented) - OBJECT = "object", - // (undocumented) - SCALED_FLOAT = "scaled_float", - // (undocumented) - SHORT = "short", - // (undocumented) - _SOURCE = "_source", - // (undocumented) - STRING = "string", - // (undocumented) - TEXT = "text", - // (undocumented) - TOKEN_COUNT = "token_count", - // (undocumented) - _TYPE = "_type", - // (undocumented) - UNSIGNED_LONG = "unsigned_long", - // (undocumented) - VERSION = "version" -} +export { ES_FIELD_TYPES } // Warning: (ae-missing-release-tag) "ES_SEARCH_STRATEGY" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -1182,7 +1112,7 @@ export function getEsQueryConfig(config: KibanaConfig): EsQueryConfig_2; // Warning: (ae-missing-release-tag) "getKbnTypeNames" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public +// @public @deprecated (undocumented) export const getKbnTypeNames: () => string[]; // Warning: (ae-forgotten-export) The symbol "ISearchRequestParams" needs to be exported by the entry point index.d.ts @@ -1879,47 +1809,7 @@ export const isQuery: (x: unknown) => x is Query; // @public (undocumented) export const isTimeRange: (x: unknown) => x is TimeRange; -// @public (undocumented) -export enum KBN_FIELD_TYPES { - // (undocumented) - ATTACHMENT = "attachment", - // (undocumented) - BOOLEAN = "boolean", - // (undocumented) - CONFLICT = "conflict", - // (undocumented) - DATE = "date", - // (undocumented) - DATE_RANGE = "date_range", - // (undocumented) - GEO_POINT = "geo_point", - // (undocumented) - GEO_SHAPE = "geo_shape", - // (undocumented) - HISTOGRAM = "histogram", - // (undocumented) - IP = "ip", - // (undocumented) - IP_RANGE = "ip_range", - // (undocumented) - MISSING = "missing", - // (undocumented) - MURMUR3 = "murmur3", - // (undocumented) - NESTED = "nested", - // (undocumented) - NUMBER = "number", - // (undocumented) - NUMBER_RANGE = "number_range", - // (undocumented) - OBJECT = "object", - // (undocumented) - _SOURCE = "_source", - // (undocumented) - STRING = "string", - // (undocumented) - UNKNOWN = "unknown" -} +export { KBN_FIELD_TYPES } // Warning: (ae-missing-release-tag) "KibanaContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md index 05ad179213713..1aea37795ddee 100644 --- a/src/plugins/data/server/server.api.md +++ b/src/plugins/data/server/server.api.md @@ -23,6 +23,7 @@ import { ElasticsearchClient as ElasticsearchClient_2 } from 'kibana/server'; import { Ensure } from '@kbn/utility-types'; import { EnvironmentMode } from '@kbn/config'; import { ErrorToastOptions } from 'src/core/public/notifications'; +import { ES_FIELD_TYPES } from '@kbn/field-types'; import { EsQueryConfig as EsQueryConfig_2 } from '@kbn/es-query'; import { estypes } from '@elastic/elasticsearch'; import { EventEmitter } from 'events'; @@ -43,6 +44,7 @@ import { ISearchOptions as ISearchOptions_2 } from 'src/plugins/data/public'; import { ISearchSource } from 'src/plugins/data/public'; import { IUiSettingsClient } from 'src/core/server'; import { IUiSettingsClient as IUiSettingsClient_3 } from 'kibana/server'; +import { KBN_FIELD_TYPES } from '@kbn/field-types'; import { KibanaExecutionContext } from 'src/core/public'; import { KibanaRequest } from 'src/core/server'; import { KibanaRequest as KibanaRequest_2 } from 'kibana/server'; @@ -353,8 +355,8 @@ export const buildQueryFromFilters: (filters: Filter_2[] | undefined, indexPatte // Warning: (ae-missing-release-tag) "castEsToKbnFieldTypeName" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // -// @public -export const castEsToKbnFieldTypeName: (esType: ES_FIELD_TYPES | string) => KBN_FIELD_TYPES; +// @public @deprecated (undocumented) +export const castEsToKbnFieldTypeName: (esType: string) => import("@kbn/field-types").KBN_FIELD_TYPES; // Warning: (ae-forgotten-export) The symbol "PluginConfigDescriptor" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "ConfigSchema" needs to be exported by the entry point index.d.ts @@ -369,79 +371,7 @@ export interface DataRequestHandlerContext extends RequestHandlerContext { search: SearchRequestHandlerContext; } -// @public (undocumented) -export enum ES_FIELD_TYPES { - // (undocumented) - ATTACHMENT = "attachment", - // (undocumented) - BOOLEAN = "boolean", - // (undocumented) - BYTE = "byte", - // (undocumented) - DATE = "date", - // (undocumented) - DATE_NANOS = "date_nanos", - // (undocumented) - DATE_RANGE = "date_range", - // (undocumented) - DOUBLE = "double", - // (undocumented) - DOUBLE_RANGE = "double_range", - // (undocumented) - FLOAT = "float", - // (undocumented) - FLOAT_RANGE = "float_range", - // (undocumented) - GEO_POINT = "geo_point", - // (undocumented) - GEO_SHAPE = "geo_shape", - // (undocumented) - HALF_FLOAT = "half_float", - // (undocumented) - HISTOGRAM = "histogram", - // (undocumented) - _ID = "_id", - // (undocumented) - _INDEX = "_index", - // (undocumented) - INTEGER = "integer", - // (undocumented) - INTEGER_RANGE = "integer_range", - // (undocumented) - IP = "ip", - // (undocumented) - IP_RANGE = "ip_range", - // (undocumented) - KEYWORD = "keyword", - // (undocumented) - LONG = "long", - // (undocumented) - LONG_RANGE = "long_range", - // (undocumented) - MURMUR3 = "murmur3", - // (undocumented) - NESTED = "nested", - // (undocumented) - OBJECT = "object", - // (undocumented) - SCALED_FLOAT = "scaled_float", - // (undocumented) - SHORT = "short", - // (undocumented) - _SOURCE = "_source", - // (undocumented) - STRING = "string", - // (undocumented) - TEXT = "text", - // (undocumented) - TOKEN_COUNT = "token_count", - // (undocumented) - _TYPE = "_type", - // (undocumented) - UNSIGNED_LONG = "unsigned_long", - // (undocumented) - VERSION = "version" -} +export { ES_FIELD_TYPES } // Warning: (ae-missing-release-tag) "ES_SEARCH_STRATEGY" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -1085,47 +1015,7 @@ export interface ISearchStrategy Observable; } -// @public (undocumented) -export enum KBN_FIELD_TYPES { - // (undocumented) - ATTACHMENT = "attachment", - // (undocumented) - BOOLEAN = "boolean", - // (undocumented) - CONFLICT = "conflict", - // (undocumented) - DATE = "date", - // (undocumented) - DATE_RANGE = "date_range", - // (undocumented) - GEO_POINT = "geo_point", - // (undocumented) - GEO_SHAPE = "geo_shape", - // (undocumented) - HISTOGRAM = "histogram", - // (undocumented) - IP = "ip", - // (undocumented) - IP_RANGE = "ip_range", - // (undocumented) - MISSING = "missing", - // (undocumented) - MURMUR3 = "murmur3", - // (undocumented) - NESTED = "nested", - // (undocumented) - NUMBER = "number", - // (undocumented) - NUMBER_RANGE = "number_range", - // (undocumented) - OBJECT = "object", - // (undocumented) - _SOURCE = "_source", - // (undocumented) - STRING = "string", - // (undocumented) - UNKNOWN = "unknown" -} +export { KBN_FIELD_TYPES } // Warning: (ae-missing-release-tag) "KibanaContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/yarn.lock b/yarn.lock index 700c602b4a6a6..030af21819857 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2798,6 +2798,10 @@ version "0.0.0" uid "" +"@kbn/field-types@link:bazel-bin/packages/kbn-field-types": + version "0.0.0" + uid "" + "@kbn/i18n@link:bazel-bin/packages/kbn-i18n": version "0.0.0" uid ""